Skip to content

Commit

Permalink
Adapt instructions on how to build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
birgits committed Mar 24, 2023
1 parent abf879d commit b08d71c
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions doc/dev_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,15 @@ Code standards
Documentation
-------------

Build the docs locally by first setting up the sphinx environment with (executed
from top-level folder)
You can build the docs locally as follows (executed from top-level eDisGo directory):

.. code-block:: bash
sphinx-apidoc -f -o doc/api edisgo
sphinx-build -E -a -b html ./doc/ <outputdir>
And then you build the html docs on your computer with
To manually check if external links in the documentation work, you can run the following command (internal links are not checked by this):

.. code-block:: bash
sphinx-build -E -a doc/ doc/_html
sphinx-build ./doc/ -b linkcheck -d _build/doctrees _build/html
To manually check if external links in the documentation work, change into the doc
repository and run the following command (internal links are not checked by this):

.. code-block:: bash
sphinx-build . -b linkcheck -d _build/doctrees _build/html

0 comments on commit b08d71c

Please sign in to comment.