stsci.sphinxex

stsci.sphinxext bevat uitbreidings aan Sphinx dokumentasie bou van STScI.
Gebruik
Hierdie instruksies dek slegs veranderings van die standaard Sphinx instruksies.
Skep 'n nuwe boom vir u Sphinx dokumentasie, die gebruik van sphinx_quickstart, soos beskryf in die Sphinx inleiding.
Voer die stsci_sphinx veranderinge in conf.py jou projek se deur invoeging van die volgende by die top:
van stsci.sphinxext.conf invoer *
Die "extensions" lyn in jou conf.py moet ook verander word sodat dit nie die gedefinieer deur stsci.sphinxext uitbreidings nie oorheers. Byvoorbeeld, verander:
uitbreidings = ['sphinx.ext.autodoc']
om:
uitbreidings + = ['sphinx.ext.autodoc']
. Ook kommentaar lewer uit die 'html_theme' line, so jou projek sal die stsci.sphinxext een gebruik

Vereistes :

• Python
• Sphinx
• numpydoc
• Matplotlib