Skip to content

Commit 74511c2

Browse files
committed
Alter comment per review but fix with apostrophe applied
1 parent b1eaa87 commit 74511c2

File tree

1 file changed

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

1 file changed

+4
-4
lines changed

doc/user_guide/features/documentation/index.rst

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

12-
The PTB uses ref:`sphinx <https://www.sphinx-doc.org/>`__ to build and validate the contents
12+
The PTB uses ref:`sphinx <https://www.sphinx-doc.org/>`__ to build and validate the contents
1313
of your project's documentation. PTB expects the project's documentation in directory ``doc``,
1414
primarily as ``rst`` files. The ``doc/conf.py`` acts as the configuration file for building the
1515
documentation.
@@ -42,8 +42,8 @@ Configuration
4242

4343
``doc/conf.py``
4444
^^^^^^^^^^^^^^^
45-
A default ``doc/conf.py`` is provided in the cookiecutter project template. If your
46-
project's needs deviates, please refer to:
45+
The PTB's cookiecutter project template already provides a file ``doc/conf.py`` with
46+
default content. If your project needs adjustment, please refer to:
4747

4848
* the `general sphinx documentation <https://www.sphinx-doc.org/en/master/>`__.
4949
* specifically to the `Linkcheck Builder <https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder>`__
@@ -52,7 +52,7 @@ project's needs deviates, please refer to:
5252
``gh-pages.yml``
5353
^^^^^^^^^^^^^^^^
5454
GitHub workflow ``gh-pages.yml`` uses actions ``upload-pages-artifact`` and ``deploy-pages``.
55-
In order to properly deploy your generated documentation, you will need to manually
55+
In order to properly deploy your generated documentation, you will need to manually
5656
reconfigure the GitHub Pages settings for the repo:
5757

5858
#. Go to the affected repo's GitHub page

0 commit comments

Comments
 (0)