Update writing_docs.rst

Some additions on how to get the local server up and running
This commit is contained in:
Daniel Bo Olesen
2024-09-27 00:00:24 +02:00
committed by Dion Moult
parent 5bb40111c1
commit c45b4372a8
@@ -186,4 +186,20 @@ Now you can generate the documentation:
cd _build/html
python -m http.server
You will now have a local webserver running hosting the documentation.
You will now have a local webserver running hosting the documentation. Your terminal
will return something like seen underneath, replace [::] with localhost.
.. code::
Serving HTTP on :: port 8000 (http://[::]:8000/) ...
When you want to see changes you have made in your IDE:
- Kill the terminal, eg. the server.
- Run the make and build sequence above again.
.. tip::
If you make small incremental changes, you can avoid the cd navigation in many IDE's
by right clicking on the docs folder and open a fresh terminal from there.