From c45b4372a8ec4fc733ea808c7f71ffee578a6f14 Mon Sep 17 00:00:00 2001 From: Daniel Bo Olesen Date: Fri, 27 Sep 2024 00:00:24 +0200 Subject: [PATCH] Update writing_docs.rst Some additions on how to get the local server up and running --- .../docs/guides/development/writing_docs.rst | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/src/bonsai/docs/guides/development/writing_docs.rst b/src/bonsai/docs/guides/development/writing_docs.rst index a3a4fe9665..64327fbb95 100644 --- a/src/bonsai/docs/guides/development/writing_docs.rst +++ b/src/bonsai/docs/guides/development/writing_docs.rst @@ -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.