Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update doc dependencies in the doc itself #10932

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update doc dependencies in the doc itself #10932

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6928605
Update doc dependencies in the doc itself
ElectreAAS Sep 17, 2024
d2aaaa6
Link requirements.txt in doc
ElectreAAS Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions doc/hacking.rst
View file
Open in desktop
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_rtd_theme_ and sphinx-copybutton_.
sphinx-design_, sphinx-copybutton_, myst-parser_, and furo_.

Build the documentation with

Expand All @@ -356,11 +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_rtd_theme: https://sphinx-rtd-theme.readthedocs.io/en/stable/
.. _sphinx-autobuild: https://pypi.org/project/sphinx-autobuild/
.. _sphinx-design: https://sphinx-design.readthedocs.io/en/latest/index.html
.. _sphinx-copybutton: https://sphinx-copybutton.readthedocs.io/en/latest/index.html
.. _dune-release: https://github.com/ocamllabs/dune-release
.. _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/

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