stsci.sphinxext indeholder udvidelser til Sphinx at opbygge dokumentation fra STScI.
Anvendelse
Disse instruktioner dækker kun ændringer fra standard Sphinx instruktioner.
Opret et nyt træ til din Sphinx dokumentation, hjælp sphinx_quickstart, som beskrevet i Sphinx introduktion.
Importer stsci_sphinx tilpasninger i din projektets conf.py ved at indsætte følgende linje i toppen:
fra stsci.sphinxext.conf import *
Den "extensions" linje i din conf.py bør også ændres, så det ikke tilsidesætte de udvidelser defineret af stsci.sphinxext. For eksempel ændres:
extensions = ['sphinx.ext.autodoc']
til:
extensions + = ['sphinx.ext.autodoc']
. Også udkommentere den »html_theme 'line, så dit projekt vil bruge stsci.sphinxext en
Krav :
- Python
- Sphinx
- numpydoc
- Matplotlib
Kommentarer ikke fundet