File size: 606 Bytes
128403f |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
Documentation
=============
Read the documentation
----------------------
Access the documentation from `index.html <build/html/index.html>`_
Generate Sphinx documentation
-----------------------------
Run the below command from ``/src/package``.
HTML format:
.. code-block:: shell
sphinx-build -M html ../../docs/source ../../docs/build --fail-on-warning
As a PDF file:
Required: Install latex - ``sudo apt-get install texlive-full``
.. code-block:: shell
sphinx-build -M latexpdf ../../docs/source ../../docs/build --fail-on-warning
Access it from `aim-cu.pdf <build/latex/aim-cu.pdf>`_ |