Skip to content

Commit 2f47607

Browse files
committed
Add sphinx-build instructions
1 parent b441e52 commit 2f47607

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

docs/CONTRIBUTING.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,19 @@ To run the tests and linters, you can use the following command:
4040
4141
For futher details, refer to the ``noxfile.py`` script.
4242

43+
Building Documentation
44+
----------------------
45+
46+
The documentation on `ReadtheDocs <https://app.readthedocs.org/projects/sqlalchemy-mptt/>`_ is manually built from the master branch.
47+
To build the documentation locally, you can run:
48+
49+
.. code-block:: bash
50+
51+
$ uv tool install sphinx --with-editable .
52+
$ cd docs
53+
$ make html
54+
55+
For futher details, refer to the ``docs/Makefile``.
56+
4357
.. |IRC Freenode| image:: https://img.shields.io/badge/irc-freenode-blue.svg
4458
:target: https://webchat.freenode.net/?channels=sacrud

0 commit comments

Comments
 (0)