sphinx-me

sphinx-moi est un outil de Python qui créera une coquille de documentation Sphinx pour votre projet et inclure le fichier README que l'index de la documentation. & Nbsp; Il gère l'extraction des méta-données nécessaires telles que le nom du projet, l'auteur et la version de votre projet pour les utiliser dans vos docs Sphinx.
Une fois que vous utilisez sphinx-moi de construire vos docs Sphinx, vous pouvez ensuite ajouter votre projet sur le site, lisez la doc et ont le README de votre projet accueilli avec un thème attractif de documentation Sphinx.
Note: Votre fichier README doit être dans un format compatible reStructuredText.
Installation
Le moyen le plus facile à installer sphinx-me est directement à partir de PyPI utilisant pip ou setuptools en exécutant la commande respective ci-dessous:
pip installer -U sphinx-moi
ou:
easy_install -U sphinx-moi
Sinon, vous pouvez télécharger sphinx-moi et l'installer directement à partir de la source:
python setup.py install
Running
sphinx-moi, il sera installé en tant que script de l'ensemble du système qui peut être exécuté à partir de la ligne de commande alors que dans le répertoire racine de votre projet:
sphinx-moi
Lorsqu'il est exécuté dans le répertoire de votre projet, il va créer un répertoire docs avec deux fichiers, le module de conf.py Sphinx, et un fichier index.rst qui comprendra le README de votre projet.
Le module conf.py appelle une fonction de configuration de sphinx-moi que met en place le minimum de paramètres nécessaires à vos docs Sphinx.
- Projet - le nom du répertoire de votre projet est utilisé.
- Version - extraites de la version de votre script arg setup.py, ou un attribut __version__ de votre colis.
- Le droit d'auteur - extraites de l'auteur de votre arg script setup.py, ou un attribut __author__ de votre colis

Exigences :

• . Python