mirror of
https://github.com/maxkratz/documentation.git
synced 2024-09-16 19:29:06 +00:00
docs: Update readme with required steps for developer docs
Signed-off-by: Julius Härtl <jus@bitgrid.net>
This commit is contained in:
parent
52fb91425b
commit
fc289da463
1 changed files with 7 additions and 3 deletions
10
README.rst
10
README.rst
|
@ -127,15 +127,19 @@ Building HTML
|
||||||
3. Change into the environment: ``pipenv shell``
|
3. Change into the environment: ``pipenv shell``
|
||||||
4. Install the dependencies ``pip install -r requirements.txt``
|
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
|
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``.
|
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``
|
1. Install ``pip install sphinx-autobuild``
|
||||||
2. Enter the documentation section ``cd user_manual``
|
2. When building the developer documentation make sure to execute ``make openapi-spec`` in the repository root
|
||||||
3. Watch for file changes ``make SPHINXBUILD=sphinx-autobuild html``
|
3. Enter the documentation section ``cd user_manual``
|
||||||
4. Open http://127.0.0.1:8000 in the browser and start editing
|
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
|
Building PDF
|
||||||
============
|
============
|
||||||
|
|
Loading…
Reference in a new issue