stsci.sphinxext tartalmaz Sphinx kiterjesztések építeni dokumentációt STScl.
Használat
Ezek az utasítások csak azokra változik a standard Sphinx utasításokat.
Hozzon létre egy új fát a Szfinx dokumentáció, használat sphinx_quickstart, ahogy az a Szfinx bevezetése.
Importálja a stsci_sphinx testreszabást be a projekt conf.py beiktatásával a következő sort a tetején:
re stsci.sphinxext.conf import *
A "kiterjesztés" sort a conf.py kell módosítani annak érdekében, hogy nem írja felül a kiterjesztések által meghatározott stsci.sphinxext. Például változik:
kiterjesztések = ['sphinx.ext.autodoc']
hogy:
kiterjesztések + = ['sphinx.ext.autodoc']
Továbbá, megjegyzésbe a "html_theme" vonalat, így a projekt fogja használni a stsci.sphinxext egyet.
követelmények :
- Python
- Sphinx
- numpydoc
- Matplotlib
Hozzászólás nem található