Commit 7f853482 authored by Kostas Demartinos's avatar Kostas Demartinos

Improve content of usage.rst

parent 36214afc
Pipeline #43005577 passed with stages
in 31 seconds
......@@ -6,40 +6,42 @@ Using the template
$ git clone <this-repo> path/to/docs/
$ make -C path/to/docs/ clean-repo
#. Configure CI for your gitlab project::
#. Set configuration options in ``path/to/docs/source/conf.py``.
$ make -C path/to/docs/ gitlab-ci
#. Add content in ``path/to/docs/source/chapters/``.
This essentially moves the required ``.gitlab-ci.yml`` to the
root level of your repository. Alternatively, you can explicitly
define the path to ``.gitlab-ci.yml`` in your project settings.
#. Modify ``path/to/docs/source/index.rst`` accordingly.
.. important::
#. Generate documentation
Don't forget to override ``DOCSPATH`` and ``MODPATH`` in ``.gitlab-ci.yml``:
* Continuous integration (applies only to ``gitlab``)::
* ``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``.
$ make -C path/to/docs/ gitlab-ci
By default CI is configured to run only when a tag is created.
This essentially moves the required ``.gitlab-ci.yml`` to the
root level of your repository. Alternatively, you can explicitly
define the path to ``.gitlab-ci.yml`` in your project settings.
#. Set configuration options in ``path/to/docs/source/conf.py``.
.. important::
#. Add content in ``path/to/docs/source/chapters/``.
Don't forget to override ``DOCSPATH`` and ``MODPATH`` in ``.gitlab-ci.yml``:
#. Modify ``path/to/docs/source/index.rst`` accordingly.
* ``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 is configured to run only when a tag is created.
* Manual generation
#. Create API docs for your package::
#. Create API docs for your package::
$ make MODPATH=<package-path> -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``.
where ``<package-path>`` is the path of the package **relative**
to ``path/to/docs``.
#. Build documentation::
$ make MODPATH=<package-path> -C path/to/docs/ apidoc html
#. Build documentation::
Precedence of ``apidoc`` over the ``html`` rule is important though.
$ make -C path/to/docs/ html
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