stsci.sphinxext contient des extensions à Sphinx de construire la documentation du STScI.
Utilisation
Ces instructions ne couvrent que les changements par rapport aux instructions Sphinx standard.
Créer un nouvel arbre pour votre documentation Sphinx, en utilisant sphinx_quickstart, comme décrit dans l'introduction Sphinx.
Importer les personnalisations de stsci_sphinx dans la conf.py de votre projet en insérant la ligne suivante en haut:
de stsci.sphinxext.conf import *
Le "extensions" ligne dans votre conf.py devrait également être modifié de sorte qu'il ne remplace pas les extensions définies par stsci.sphinxext. Par exemple, changer:
extensions = ['sphinx.ext.autodoc']
à:
extensions + = ['sphinx.ext.autodoc']
. Aussi, commentez la ligne 'html_theme', de sorte que votre projet va utiliser le stsci.sphinxext un
Exigences :
- Python
- Sphinx
- numpydoc
- Matplotlib
Commentaires non trouvées