borgbackup/docs/introduction.rst

Introduction
============

.. This shim is here to fix the structure in the PDF
   rendering. Without this stub, the elements in the toctree of
   index.rst show up a level below the README file included there.

.. include:: ../README.rst
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`
			`============`

docs: fix typos and grammar 2025-08-11 09:26:24 -04:00			`.. This shim is here to fix the structure in the PDF`
			`rendering. Without this stub, the elements in the toctree of`
			`index.rst show up a level below the README file included there.`
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:: ../README.rst`