Improve content of usage.rst

parent 36214afc
Pipeline #43005577 passed with stages
in 31 seconds
......@@ -6,7 +6,15 @@ 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``.
#. Add content in ``path/to/docs/source/chapters/``.
#. Modify ``path/to/docs/source/index.rst`` accordingly.
#. Generate documentation
* Continuous integration (applies only to ``gitlab``)::
$ make -C path/to/docs/ gitlab-ci
......@@ -25,21 +33,15 @@ Using the template
By default CI is configured to run only when a tag is created.
#. Set configuration options in ``path/to/docs/source/conf.py``.
#. Add content in ``path/to/docs/source/chapters/``.
* Manual generation
#. Modify ``path/to/docs/source/index.rst`` accordingly.
#. Create API docs for your package::
#. Create API docs for your package::
$ 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 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