|
Here is a readme file to help the setup of sphinx documentation (for python scripts)
|
|
Here is a readme file to help the setup of sphinx documentation (for python scripts)
|
|
|
|
|
|
|
|
# Configuration
|
|
|
|
|
|
Before make html, execute :
|
|
Before make html, execute :
|
|
|
|
|
|
|
|
```java
|
|
source ~/.yafits.bashrc
|
|
source ~/.yafits.bashrc
|
|
|
|
```
|
|
|
|
|
|
|
|
# Create the documentation directory structure
|
|
|
|
|
|
|
|
rm docs
|
|
|
|
# sphinx-quickstart
|
|
|
|
|
|
sphinx-apidoc -o ./source/ ../foo/ --force
|
|
sphinx-apidoc -o ./source/ ../foo/ --force
|
|
make clean
|
|
make clean
|
|
make html
|
|
make html
|
|
|
|
|
|
|
|
|
|
# rm docs
|
|
|
|
# sphinx-quickstart
|
|
|
|
|
|
|
|
Editer le conf.py, ici un exemple
|
|
Editer le conf.py, ici un exemple
|
|
|
|
|
... | | ... | |