1
0
mirror of https://github.com/certbot/certbot.git synced 2026-01-26 07:41:33 +03:00

Update instructions about how to build docs (#7605)

This commit is contained in:
Brad Warren
2020-01-30 11:47:48 -08:00
committed by GitHub
parent 11e402893f
commit 8d9943cb08

View File

@@ -524,19 +524,22 @@ during the next release.
Updating the documentation
==========================
In order to generate the Sphinx documentation, run the following
commands:
Many of the packages in the Certbot repository have documentation in a
``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
make -C docs clean html man
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.
make clean html
This would generate the HTML documentation in ``_build/html`` in your current
``docs/`` directory.
.. _docker-dev: