Premiers pas avec Sphinx. Générer docstring avec Sphinx
Sphinx-Apidoc génère automatiquement une docstring python Utilise OSX 10.9.4. Utilise Sphinx v1.1.3. Après avoir installé sphinx. Que fais-tu maintenant?
Structure du répertoire
├── documents_source/
├── publish/
└── src/
└── main.py
main.py
# -*- coding: UTF-8 -*-
import sys
def main(name, age=None):
"""Greeting function.
:param name: Your name.
:param age: Youre age. (option)
"""
print "hello, " + name
if age is not None:
print "You are " + age
Génération de papier à lettres
Exécutez la commande sphinx-apidoc.
$ sphinx-apidoc -F -o ./documents_source ./src
Ce qui précède n'est que pour la première fois. Générez une configuration complète avec l'option -F. À partir de la deuxième fois, exécutez ceci.
$ sphinx-apidoc -f -o ./documents_source ./src
Il y a de nombreux fichiers sous `` documents_source / ''. Ceci est la source de la documentation générée.
## Autoriser l'importation du module cible
Ouvrez `` documents_source / conf.py '' et éditez et activez cette partie commentée. Le module autodoc importe et lit le fichier cible, il vous indique donc l'emplacement.
#### **` conf.py`**
```py
#sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../src'))
Sortie de document
Exécutez la commande sphinx-build.
$ sphinx-build -a ./documents_source ./publish
Vérifiez qu'il sera généré sous forme de document consultable sous le répertoire `` publish / ''.
Il est affiché comme suit.
Il est plus facile de comprendre si vous lisez le document officiel après avoir supprimé ce flux. http://docs.sphinx-users.jp/index.html
Recommended Posts