Skip to content

Commit

Permalink
[docs] add some notes on how to generate docs locally
Browse files Browse the repository at this point in the history
  • Loading branch information
gipert committed Nov 5, 2024
1 parent 9654fb9 commit 1a4e65f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/developer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,18 @@ following:
other) must be provided as separate pages in ``docs/`` and linked in the
table of contents.

To generate documentation locally, run

.. code-block:: console
$ cd remage/build/
$ cmake .. -DRMG_BUILD_DOCS=ON
$ make sphinx
You'll need a Doxygen installation and Python software dependencies specified
in ``docs/environment.yml``. The generated documentation can be viewed by
pointing your browser to ``docs/_build/index.html``.

Writing documentation
^^^^^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit 1a4e65f

Please sign in to comment.