maxkratz/documentation
1
0
Fork 0
mirror of https://github.com/maxkratz/documentation.git synced 2024-09-07 23:33:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: Update readme with required steps for developer docs

Browse source 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
This commit is contained in:
Julius Härtl 2023-06-06 15:24:42 +02:00
parent 52fb91425b
commit fc289da463
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.rst
View file

@ -127,15 +127,19 @@ Building HTML
3. Change into the environment: ``pipenv shell``
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
The build assets will be put into the individual documentation subdirectories like ``developer_manual/_build/html/com``
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:
1. Install ``pip install sphinx-autobuild``
2. Enter the documentation section ``cd user_manual``
3. Watch for file changes ``make SPHINXBUILD=sphinx-autobuild html``
4. Open http://127.0.0.1:8000 in the browser and start editing
2. When building the developer documentation make sure to execute ``make openapi-spec`` in the repository root
3. Enter the documentation section ``cd user_manual``
4. Watch for file changes ``make SPHINXBUILD=sphinx-autobuild html``
5. Open http://127.0.0.1:8000 in the browser and start editing
Building PDF
============