Update usage.rst

parent 9d8f1bba
Pipeline #43003054 passed with stages
in 32 seconds
......@@ -16,11 +16,14 @@ Using the template
.. important::
Don't forget to override the ``DOCSPATH`` variable in ``.gitlab-ci.yml``
with the actual path of your project's docs. E.g. ``path/to/docs``.
Don't forget to override ``DOCSPATH`` and ``MODPATH`` in ``.gitlab-ci.yml``:
* ``DOCSPATH`` should be assigned the value of the path you cloned the repository
into.
* ``MODPATH`` should be assinged the value of the path of the python-package
to be documented **relative** to the ``DOCSPATH``.
By default CI runs when a tag is created and published.
By default CI is configured to run only when a tag is created.
#. Set configuration options in ``path/to/docs/source/conf.py``.
......@@ -30,16 +33,13 @@ Using the template
#. Create API docs for your package::
$ make MODPATH=path/to/package -C path/to/docs/ apidoc
$ make MODPATH=<package-path> -C path/to/docs/ apidoc
where ``<package-path>`` is the path of the package **relative**
to ``path/to/docs``.
#. Build documentation::
$ make -C path/to/docs/ html
.. hint::
Of course, the last two commands can be combined as follows::
$ make -C path/to/docs/ MODPATH=path/to/package apidoc html
$ make MODPATH=<package-path> -C path/to/docs/ apidoc html
Precedence of ``apidoc`` over the ``html`` rule is important though.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment