borg/docs/book.rst

:orphan:

.. include:: global.rst.inc

Borg documentation
==================

.. when you add an element here, do not forget to add it to index.rst
.. Note: Some things are in appendices (see latex_appendices in conf.py)

.. toctree::
    :maxdepth: 2

    introduction
    installation
    quickstart
    usage
    deployment
    faq
    support
    changes
    internals
    development
    authors
[DOCS] #4587 – Make Sphinx warnings break docs build Prevent warnings of type "checking consistency... WARNING: document isn't included in any toctree" by using the :orphan: directive. 2020-03-14 20:01:36 +01:00			`:orphan:`

fix PDF rendering structure without those changes, all of the toctree document headings do not show up. they are considered to be "below" the last heading of the README file. we also remove the "Notes" section from the readme as there is only one note, regarding the fork. we introduce a stub "introduction" element in the toctree, otherwise it is impossible for the PDF rendered to render the README correctly. this is to workaround a bug in the PDF renderer. 2016-11-03 12:54:07 -05:00			`.. include:: global.rst.inc`

			`Borg documentation`
			`==================`

			`.. when you add an element here, do not forget to add it to index.rst`
docs: create appendices in the book 2017-05-18 22:39:43 +02:00			`.. Note: Some things are in appendices (see latex_appendices in conf.py)`
fix PDF rendering structure without those changes, all of the toctree document headings do not show up. they are considered to be "below" the last heading of the README file. we also remove the "Notes" section from the readme as there is only one note, regarding the fork. we introduce a stub "introduction" element in the toctree, otherwise it is impossible for the PDF rendered to render the README correctly. this is to workaround a bug in the PDF renderer. 2016-11-03 12:54:07 -05:00
			`.. toctree::`
remove third level headings, too verbose 2016-11-04 21:15:31 -04:00			`:maxdepth: 2`
fix PDF rendering structure without those changes, all of the toctree document headings do not show up. they are considered to be "below" the last heading of the README file. we also remove the "Notes" section from the readme as there is only one note, regarding the fork. we introduce a stub "introduction" element in the toctree, otherwise it is impossible for the PDF rendered to render the README correctly. this is to workaround a bug in the PDF renderer. 2016-11-03 12:54:07 -05:00
			`introduction`
			`installation`
			`quickstart`
			`usage`
			`deployment`
			`faq`
[DOCS] #4587 – Make Sphinx warnings break docs build Prevent warnings of type "checking consistency... WARNING: document isn't included in any toctree" by using the :orphan: directive. 2020-03-14 20:01:36 +01:00			`support`
			`changes`
fix PDF rendering structure without those changes, all of the toctree document headings do not show up. they are considered to be "below" the last heading of the README file. we also remove the "Notes" section from the readme as there is only one note, regarding the fork. we introduce a stub "introduction" element in the toctree, otherwise it is impossible for the PDF rendered to render the README correctly. this is to workaround a bug in the PDF renderer. 2016-11-03 12:54:07 -05:00			`internals`
			`development`
[DOCS] #4587 – Make Sphinx warnings break docs build Prevent warnings of type "checking consistency... WARNING: document isn't included in any toctree" by using the :orphan: directive. 2020-03-14 20:01:36 +01:00			`authors`