Skip to content
Snippets Groups Projects
Commit ede558df authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Fix the directory structure for documentation in the reference manual.

parent 76fe6e01
No related branches found
No related tags found
No related merge requests found
...@@ -21,21 +21,30 @@ Documentation ...@@ -21,21 +21,30 @@ Documentation
format following the Google Python Style Guide (more details in the format following the Google Python Style Guide (more details in the
sphinx napoleon_ extension). sphinx napoleon_ extension).
The documentation is generated using sphinx_ generator. We recommend to use following directory structure::
The master document is located in the directory
``myapplication/docs``. Its skeleton is created using the command
``sphinx-quickstart``::
> cd myapplication/docs myapplications/docs
myapplications/docs/api
myapplications/docs/reference
myapplications/docs/user
The documentation is split in three blocks: the python API, the reference
manual for developers and the users manual.
The documentation is generated using the sphinx_ generator.
The first skeleton is obtained via the command
``sphinx-quickstart``, *e.g.*::
> cd myapplication/docs/api
> sphinx-quickstart > sphinx-quickstart
Once the documentation written, the ``HTML`` version is obtained by:: Once the documentation written, the ``HTML`` version is generated by::
> cd myapplication > cd myapplication/docs/api
> sphinx-build -b html docs static/docs/sphinx > sphinx-build -b html docs static/docs/api
The documentation can be seen from your application, via the URL The documentation can be seen from your application, via the URL
``http(s)://mydomain/myapplication/static/docs/sphinx/index.html`` ``http(s)://mydomain/myapplication/static/docs/api/index.html``
*Javascript widget documentation* *Javascript widget documentation*
Write the documentation of your javascript classes using jsduck_. Write the documentation of your javascript classes using jsduck_.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment