Skip to content

Commit 8668872

Browse files
ArBridgemanckunki
andauthored
Improve introduction of documentation per review
Co-authored-by: Christoph Kuhnke <[email protected]>
1 parent 226058b commit 8668872

File tree

1 file changed

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

1 file changed

+3
-3
lines changed

doc/user_guide/features/documentation/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Deploying documentation
99
multiversion
1010
troubleshooting
1111

12-
In the PTB, we use sphinx to build and validate the contents of a project's
13-
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
12+
The PTB uses ref:`sphinx <https://www.sphinx-doc.org/>`__ to build and validate the contents
13+
of your project's documentation. PTB expects the project's documentation in directory ``doc``,
14+
primarily as ``rst`` files. The ``doc/conf.py`` acts as the configuration file for building the
1515
documentation.
1616

1717
Many of the nox session checks are executed in the ``checks.yml`` so that alterations

0 commit comments

Comments
 (0)