Skip to content

Commit a50384a

Browse files
authored
doc: update dune dependencies in the doc itself (ocaml#10932)
Signed-off-by: Ambre Austen Suhamy <[email protected]>
1 parent 2164453 commit a50384a

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

doc/hacking.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,8 @@ consists of two steps:
206206
* Running ``$ make opam-release`` to create the release tarball. Then publish it
207207
to GitHub and submit it to opam.
208208

209+
.. _dune-release: https://github.com/tarides/dune-release
210+
209211
Major & Feature Releases
210212
------------------------
211213

@@ -342,7 +344,7 @@ Documentation
342344
User documentation lives in the ``./doc`` directory.
343345

344346
In order to build the user documentation, you must install python-sphinx_,
345-
sphinx_rtd_theme_ and sphinx-copybutton_.
347+
sphinx-design_, sphinx-copybutton_, myst-parser_, and furo_.
346348

347349
Build the documentation with
348350

@@ -356,11 +358,15 @@ For automatically updated builds, you can install sphinx-autobuild_, and run
356358
357359
$ make livedoc
358360
361+
.. seealso::
362+
``doc/requirements.txt`` for an always up-to-date list of packages to install
363+
359364
.. _python-sphinx: http://www.sphinx-doc.org/en/master/usage/installation.html
360-
.. _sphinx_rtd_theme: https://sphinx-rtd-theme.readthedocs.io/en/stable/
361-
.. _sphinx-autobuild: https://pypi.org/project/sphinx-autobuild/
365+
.. _sphinx-design: https://sphinx-design.readthedocs.io/en/latest/index.html
362366
.. _sphinx-copybutton: https://sphinx-copybutton.readthedocs.io/en/latest/index.html
363-
.. _dune-release: https://github.com/ocamllabs/dune-release
367+
.. _sphinx-autobuild: https://pypi.org/project/sphinx-autobuild/
368+
.. _myst-parser: https://myst-parser.readthedocs.io/en/latest/
369+
.. _furo: https://sphinx-themes.org/sample-sites/furo/
364370

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

0 commit comments

Comments
 (0)