... | ... | @@ -10,18 +10,39 @@ source ~/.yafits.bashrc |
|
|
|
|
|
# Create the documentation directory structure
|
|
|
|
|
|
```java
|
|
|
rm docs
|
|
|
# sphinx-quickstart
|
|
|
sphinx-quickstart
|
|
|
```java
|
|
|
|
|
|
will create the directory docs/
|
|
|
|
|
|
# Adapt the default configuration
|
|
|
|
|
|
Need to modify 2 files : conf.py and index.rst
|
|
|
|
|
|
# Finalise the documentation structure
|
|
|
|
|
|
(with the proper config adapted as described above)
|
|
|
|
|
|
```java
|
|
|
sphinx-apidoc -o ./source/ ../foo/ --force
|
|
|
make clean
|
|
|
make html
|
|
|
```
|
|
|
|
|
|
# Compile and create the documentation in html
|
|
|
|
|
|
The only one command that needs to be executed everytime there is a change in the python files (documentation addition).
|
|
|
|
|
|
```java
|
|
|
make clean
|
|
|
make html
|
|
|
```
|
|
|
|
|
|
# Cnfiguration files
|
|
|
|
|
|
Editer le conf.py, ici un exemple
|
|
|
|
|
|
```java
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
|
#
|
|
|
# This file only contains a selection of the most common options. For a full
|
... | ... | @@ -73,10 +94,13 @@ html_theme = 'sphinx_rtd_theme' |
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
|
html_static_path = ['_static']
|
|
|
```
|
|
|
|
|
|
|
|
|
Editer index.rst, ici un exemple
|
|
|
|
|
|
|
|
|
```java
|
|
|
.. P documentation master file, created by
|
|
|
sphinx-quickstart on Thu Nov 4 17:44:19 2021.
|
|
|
You can adapt this file completely to your liking, but it should at least
|
... | ... | @@ -97,7 +121,7 @@ Indices and tables |
|
|
* :ref:`genindex`
|
|
|
* :ref:`modindex`
|
|
|
* :ref:`search`
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
[readme](uploads/7a00255e7c1bcd0322890969637b5756/readme) |
|
|
\ No newline at end of file |