C'est pratique si vous pouvez voir le document API de la classe que vous créez lors de la création d'un programme J'ai donc résumé comment créer et parcourir automatiquement des documents API pour les modules Python à l'aide de Sphinx.
Linux (cette fois je l'ai fait avec CentOS 6.6) Python 2.7 (pip installé)
Sphinx est un outil de création de documents. (Au fait, il est écrit en Python.) En bref, c'est un outil qui facilite la création de «documents intelligents et beaux». Référence: http://docs.sphinx-users.jp/
Avec pip, c'est facile à installer.
$ pip install sphinx
Je l'ai fait avec la structure de répertoires suivante.
- project #Projet Python
|
|- src #Répertoire de code Python pour lequel vous souhaitez générer automatiquement la documentation API
| |- __init__.py ou quelque chose
| |- hoge #Sous-modules
|
|- docs #Répertoire du projet Sphinx
Créez un projet Sphinx pour la documentation de l'API dans le répertoire docs. Cela peut être créé avec une seule commande.
$ cd project
$ sphinx-apidoc -F -o docs/ src/
Dans l'option "-o" de la commande sphinx-apidoc, spécifiez le répertoire dans lequel vous voulez créer le projet Sphinx, et dans le dernier argument, spécifiez le répertoire de la source Python où vous voulez générer le document API. (L'option "-F" semble être une option pour créer un projet Sphinx complet. Je l'ajouterai pour l'instant.)
Vous êtes maintenant prêt à générer la documentation de l'API à partir de la source Python sous le répertoire src. (De bonne heure
Allez dans le répertoire docs et exécutez la commande make.
$ cd docs
$ make html
Cela créera la documentation de l'API à partir de la source Python.
Au fait, si vous mettez à jour le code source Faites à nouveau "make html" pour obtenir la dernière documentation de l'API.
docs/_build/html Un fichier HTML est créé en dessous. "Index.html" est la page d'accueil.
Si vous pouvez le voir localement, ouvrez-le dans votre navigateur.
Il n'y a pas d'interface graphique sur la VM distante! Qui dit
$ cd _build/html
$ python -m SimpleHTTPServer
Ainsi, si vous configurez un serveur Web simple, vous pouvez le voir à distance. C'est juste simple et il ne semble pas y avoir de cache, donc Mise à jour du fichier HTML (make html) → mise à jour du navigateur (F5) Vous pouvez consulter les dernières informations sur.
Je l'ai trouvé au milieu de l'écriture.
http://qiita.com/icoxfog417/items/9e2eb932b61aa9b9e427
Si vous souhaitez en savoir plus, veuillez consulter ↑.
Recommended Posts