stsci.sphinxext innehåller tillägg till Sphinx att bygga dokumentation från STScI.
Användning
Dessa anvisningar omfattar endast ändringar från standard Sphinx instruktioner.
Skapa ett nytt träd för Sphinx dokumentation, med användning sphinx_quickstart, såsom beskrives i Sphinx introduktion.
Importera stsci_sphinx anpassningar i ditt projekt conf.py genom att föra in följande rad på toppen:
från stsci.sphinxext.conf import *
Den "extensions" linje i conf.py bör också ändras så att den inte åsidosätter tillägg definieras av stsci.sphinxext. Till exempel, ändra:
extensions = ['sphinx.ext.autodoc']
till:
förlängningar + = ['sphinx.ext.autodoc']
. Dessutom, kommentera ut "html_theme" linje, så projektet kommer att använda stsci.sphinxext en
Krav :
- Python
- Sphinx
- numpydoc
- matplotlib
Kommentarer hittades inte