Skip to content

Commit

Permalink
How to run Documentation locally
Browse files Browse the repository at this point in the history
  • Loading branch information
jscheidtmann committed Dec 18, 2024
1 parent abc5034 commit 75892ae
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/source/dev_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,17 @@ Documentation

The `PiFinder documentation <https://pifinder.readthedocs.io/en/release/index.html>`_
is written in `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#external-links>`_ .
The files are located in PiFinders GitHub repository under ``docs`` and have
the ending ``.rst``. Many open source projects use `redthedocs.io <eadthedocs.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 <eadthedocs.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
---------------------------------
Expand Down

0 comments on commit 75892ae

Please sign in to comment.