Skip to content

Commit cbabb48

Browse files
ArBridgemanckunki
andauthored
Update description to make clearer GitHub workflows & nicer content per review
Co-authored-by: Christoph Kuhnke <[email protected]>
1 parent df87e44 commit cbabb48

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
@@ -14,9 +14,9 @@ of your project's documentation. PTB expects the project's documentation in dire
1414
primarily as ``rst`` files. The ``doc/conf.py`` acts as the configuration file for building the
1515
documentation.
1616

17-
Many of the nox session checks are executed in the ``checks.yml`` so that alterations
18-
in the documentation can be directly attributed (and, if needed, fixed) in the relevant
19-
PR. The final building & serving of the documentation happens in the ``gh-pages.yml``.
17+
GitHub workflow ``checks.yml`` also runs the checks for the documention.
18+
This enables updating and fixing the documentation together with other changes in the same pull request.
19+
The final building & serving of the documentation happens in GitHub workflow ``gh-pages.yml``.
2020

2121
+--------------------------+------------------+----------------------------------------+
2222
| Nox session | CI Usage | Action |

0 commit comments

Comments
 (0)