From 75892ae242088335a7152c9a7c87c62cf92dc025 Mon Sep 17 00:00:00 2001 From: Jens Scheidtmann Date: Wed, 18 Dec 2024 20:02:14 +0100 Subject: [PATCH] How to run Documentation locally --- docs/source/dev_guide.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/source/dev_guide.rst b/docs/source/dev_guide.rst index 668463ac..d89f1225 100644 --- a/docs/source/dev_guide.rst +++ b/docs/source/dev_guide.rst @@ -58,12 +58,17 @@ Documentation The `PiFinder documentation `_ is written in `reStructuredText `_ . -The files are located in PiFinders GitHub repository under ``docs`` and have -the ending ``.rst``. Many open source projects use `redthedocs.io ` -for creating documentation since it is immediately generated, when you are committing -the GitHub code (CI/CD pipeline). It is very easy to link your fork of the documentation -code to GitHub. +The files are located in PiFinders GitHub repository under ``docs/source`` and have +the ending ``.rst``. We publish the documentation to `redthedocs.io `_ manually. +For reviewing your changes to the docs locally, install sphinx into your development environment using pip: + +.. code-block:: + + pip install sphinx sphinx_rtd_theme + +and then use the supplied Makefile using ``make html``. +The docs are then stored in ``build/html``. To serve it locally run ``python -m http.server`` in the html directory. Setup the development environment ---------------------------------