Skip to content

Commit 712a74a

Browse files
committed
Write as conf.py included in cookiecutter project template, so don't need to provide specific config instructions here
1 parent c85ead7 commit 712a74a

File tree

1 file changed

+2
-2
lines changed
  • doc/user_guide/features/documentation

1 file changed

+2
-2
lines changed

doc/user_guide/features/documentation/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Building documentation
1111

1212
In the PTB, we use sphinx to build and validate the contents of a project's
1313
documentation. All documentation is provided in the ``doc`` directory, primarily as
14-
`rst` files. The ``doc/conf.py`` acts as the configuration file for building the
15-
documentation.
14+
``rst`` files. The ``doc/conf.py`` acts as the configuration file for building the
15+
documentation, and a default one is provided in the cookiecutter project template.
1616

1717
Many of the nox session checks are executed in the ``checks.yml`` so that alterations
1818
in the documentation can be directly attributed (and, if needed, fixed) in the relevant

0 commit comments

Comments
 (0)