upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-06-11 09:59:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 6
borgbackup/docs/book.rst

25 lines
401 B
ReStructuredText
Raw Permalink Normal View History

[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 15:01:36 -04: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 13:54:07 -04: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 16:39:43 -04: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 13:54:07 -04: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 13:54:07 -04: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 15:01:36 -04: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 13:54:07 -04: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 15:01:36 -04:00
authors
Reference in a new issue Copy permalink