mirror of
https://github.com/certbot/certbot.git
synced 2026-07-31 18:34:41 +02:00
Update instructions about how to build docs (#7605)
This commit is contained in:
@@ -524,19 +524,22 @@ during the next release.
|
|||||||
Updating the documentation
|
Updating the documentation
|
||||||
==========================
|
==========================
|
||||||
|
|
||||||
In order to generate the Sphinx documentation, run the following
|
Many of the packages in the Certbot repository have documentation in a
|
||||||
commands:
|
``docs/`` directory. This directory is located under the top level directory
|
||||||
|
for the package. For instance, Certbot's documentation is under
|
||||||
|
``certbot/docs``.
|
||||||
|
|
||||||
|
To build the documentation of a package, make sure you have followed the
|
||||||
|
instructions to set up a `local copy`_ of Certbot including activating the
|
||||||
|
virtual environment. After that, ``cd`` to the docs directory you want to build
|
||||||
|
and run the command:
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
|
|
||||||
make -C docs clean html man
|
make clean html
|
||||||
|
|
||||||
This should generate documentation in the ``docs/_build/html``
|
|
||||||
directory.
|
|
||||||
|
|
||||||
.. note:: If you skipped the "Getting Started" instructions above,
|
|
||||||
run ``pip install -e "certbot[docs]"`` to install Certbot's docs extras modules.
|
|
||||||
|
|
||||||
|
This would generate the HTML documentation in ``_build/html`` in your current
|
||||||
|
``docs/`` directory.
|
||||||
|
|
||||||
.. _docker-dev:
|
.. _docker-dev:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user