Skip to content

Commit

Permalink
Link requirements.txt in doc
Browse files Browse the repository at this point in the history
Signed-off-by: Ambre Austen Suhamy <[email protected]>
  • Loading branch information
ElectreAAS committed Oct 23, 2024
1 parent 875441b commit 41ecc9c
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions doc/hacking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,8 @@ consists of two steps:
* Running ``$ make opam-release`` to create the release tarball. Then publish it
to GitHub and submit it to opam.

.. _dune-release: https://github.com/tarides/dune-release

Major & Feature Releases
------------------------

Expand Down Expand Up @@ -342,7 +344,7 @@ Documentation
User documentation lives in the ``./doc`` directory.

In order to build the user documentation, you must install python-sphinx_,
sphinx-design_, myst-parser_, sphinx-copybutton_, and furo_.
sphinx-design_, sphinx-copybutton_, myst-parser_, and furo_.

Build the documentation with

Expand All @@ -356,13 +358,15 @@ For automatically updated builds, you can install sphinx-autobuild_, and run
$ make livedoc
.. seealso::
``doc/requirements.txt`` for an always up-to-date list of packages to install

.. _python-sphinx: http://www.sphinx-doc.org/en/master/usage/installation.html
.. _sphinx-design: https://sphinx-design.readthedocs.io/en/latest/index.html
.. _myst-parser: https://myst-parser.readthedocs.io/en/latest/
.. _sphinx-autobuild: https://pypi.org/project/sphinx-autobuild/
.. _sphinx-copybutton: https://sphinx-copybutton.readthedocs.io/en/latest/index.html
.. _sphinx-autobuild: https://pypi.org/project/sphinx-autobuild/
.. _myst-parser: https://myst-parser.readthedocs.io/en/latest/
.. _furo: https://sphinx-themes.org/sample-sites/furo/
.. _dune-release: https://github.com/ocamllabs/dune-release

Nix users may drop into a development shell with the necessary dependencies for
building docs ``nix develop .#doc``.
Expand Down

0 comments on commit 41ecc9c

Please sign in to comment.