Update README.rst

Signed-off-by: Joas Schilling <213943+nickvergessen@users.noreply.github.com>
This commit is contained in:
Joas Schilling
2023-03-08 11:25:39 +01:00
committed by GitHub
parent 72eac1b63b
commit c0e937a3b4

View File

@@ -115,9 +115,9 @@ Building HTML
4. Install the dependencies ``pip install -r requirements.txt``
5. Now you can use ``make ...`` to build all the stuff - for example ``make html`` to build the HTML flavor of all manuals
To change into this environment you need to run `pipenv shell` to launch the shell and to exit you can use either ``exit`` or ``Ctrl`` + ``D``.
To change into this environment you need to run ``pipenv shell`` to launch the shell and to exit you can use either ``exit`` or ``Ctrl`` + ``D``.
When editing the documentation installing `sphinx-autobuild` though pip can be helpful. This will watch file changes and automatically reload the html preview:
When editing the documentation installing ``sphinx-autobuild`` though pip can be helpful. This will watch file changes and automatically reload the html preview:
1. Install ``pip install sphinx-autobuild``
2. Enter the documentation section ``cd user_manual``