borg/docs/index.rst

.. include:: global.rst.inc


Borg Documentation
==================

.. toctree::
   :maxdepth: 2

   intro
   installation
   quickstart
   usage
   faq
   support
   changes
   internals
   development
   api
Docs improvements 2013-06-29 21:56:44 +00:00			`.. include:: global.rst.inc`
Initial documentation 2011-11-05 18:42:28 +00:00
docs: install docs, faq improvements, other minor changes 2015-05-14 18:47:08 +00:00
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end 2015-08-06 10:59:51 +00:00			`Borg Documentation`
			`==================`
Initial documentation 2011-11-05 18:42:28 +00:00
Docs improvements 2013-06-29 21:56:44 +00:00			`.. toctree::`
			`:maxdepth: 2`
Initial documentation 2011-11-05 18:42:28 +00:00
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end 2015-08-06 10:59:51 +00:00			`intro`
Added more installation documentation. 2013-06-30 19:30:17 +00:00			`installation`
More documentation work 2013-07-31 18:51:01 +00:00			`quickstart`
Renamed commands.rst to usage.rst 2013-08-04 19:23:12 +00:00			`usage`
Docs improvements 2013-06-29 21:56:44 +00:00			`faq`
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end 2015-08-06 10:59:51 +00:00			`support`
			`changes`
clarify some bits I missed 2014-12-16 15:03:20 +00:00			`internals`
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end 2015-08-06 10:59:51 +00:00			`development`
add automatically generated API this is a crude hack for now, and could use a better table of contents but at least we have some way of linking and showing the different internal functions the next phase here is obviously to document that API through the addition of docstrings. a static api.rst could also be easier to read, but maybe that could go through some docstrings as well, to be tested 2015-09-30 22:35:54 +00:00			`api`