Shared Sphinx resources¶

The shared Sphinx resources is a folder with files we use when building our document trees. The folder is shared over several repositories.

The /shared folder of a doctree.

The tested.rst file is used by adding the following line before the startup block:

.. include:: /../docs/shared/include/tested.rst

The defs.rst file is used by adding the following line to the top of the document:

.. include:: /../docs/shared/include/defs.rst

A doctree which uses Shared Sphinx resources should add the following to its conf.py file:

exclude_patterns = ['.build/*', 'shared/include/*']