Browse Source

Add page on how to build the documentation

Closes PYADAPT-97.
PYADPT-97
juga 5 years ago
parent
commit
81113ca5b2
  1. 13
      docs/source/documentation.rst
  2. 1
      docs/source/index.rst

13
docs/source/documentation.rst

@ -0,0 +1,13 @@
Building the documentation
=========================
This documentation uses `Sphinx <https://www.sphinx-doc.org/>`_
It can be built in different formats.
Run ``cd docs; make`` to see the possible formats.
Run ``cd docs; make html`` to build the documentation in HTML format.
You can see the generated HTML documentation in a browser opening the directory
`docs/build/html`.

1
docs/source/index.rst

@ -12,6 +12,7 @@ Welcome to pEpPythonAdapter's documentation!
install
testing
documentation
software_using
api/pEp

Loading…
Cancel
Save