diff options
| author | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2023-02-15 02:10:09 +0000 |
|---|---|---|
| committer | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2023-02-15 03:10:50 +0000 |
| commit | ff852bc7c31f48e66100e4647749fc199d92ca79 (patch) | |
| tree | 6c5f2314fdd941d348d7125f85c8062b13895136 /doc/internals | |
| parent | bb9821b968388b788e5af7f079b738302416bb9a (diff) | |
| download | sphinx-git-ff852bc7c31f48e66100e4647749fc199d92ca79.tar.gz | |
Update GitHub Actions workflows
Diffstat (limited to 'doc/internals')
| -rw-r--r-- | doc/internals/contributing.rst | 16 |
1 files changed, 6 insertions, 10 deletions
diff --git a/doc/internals/contributing.rst b/doc/internals/contributing.rst index 6d5279f9e..a8753dddc 100644 --- a/doc/internals/contributing.rst +++ b/doc/internals/contributing.rst @@ -154,10 +154,10 @@ Please follow these guidelines when writing code for Sphinx: * Add appropriate unit tests. -Style and type checks can be run using ``tox``:: +Style and type checks can be run as follows:: - tox -e mypy - tox -e flake8 + ruff . + mypy sphinx/ Unit tests ~~~~~~~~~~ @@ -252,13 +252,9 @@ documentation, as well as key aspects of a few different tools that we use. Build the documentation ~~~~~~~~~~~~~~~~~~~~~~~ -We use `the tox tool <https://tox.wiki/en/latest/>`__ to quickly build the -documentation. Tox is kind-of like a Makefile, but includes the ability to -install an isolated environment used to run each task. +To build the documentation, run the following command:: -To build the documentation with ``tox``, run the following command:: - - tox -e docs + sphinx-build -M html ./doc ./build/sphinx -W --keep-going This will parse the Sphinx documentation's source files and generate HTML for you to preview in ``build/sphinx/html``. @@ -267,7 +263,7 @@ You can also build a **live version of the documentation** that you can preview in the browser. It will detect changes and reload the page any time you make edits. To do so, run the following command:: - tox -e docs-live + sphinx-autobuild ./doc ./build/sphinx/ Translations ~~~~~~~~~~~~ |