stsci.sphinxext bevat Sphinx uitbreidingen documentatie bouwen vanaf STScI.
Gebruik
Deze instructies alleen betrekking veranderingen van de standaard Sphinx instructies.
Maak een nieuwe boom voor uw Sphinx documentatie, met behulp sphinx_quickstart, zoals beschreven in de Sphinx inleiding.
Importeer de stsci_sphinx aanpassingen in conf.py van uw project door het invoegen van de volgende lijn aan de bovenkant:
van stsci.sphinxext.conf import *
De "extensies" regel in uw conf.py moet ook worden aangepast, zodat het niet de door stsci.sphinxext extensies doet overschrijven. Bijvoorbeeld, te wijzigen:
extensions = ['sphinx.ext.autodoc']
naar:
extensions + = ['sphinx.ext.autodoc']
. Ook, commentaar uit de 'html_theme' lijn, zodat uw project zal de stsci.sphinxext een te gebruiken
Eisen
- Python
- Sphinx
- numpydoc
- matplotlib
Reacties niet gevonden