stsci.sphinxext enthält Erweiterungen Sphinx in der Dokumentation von STScI bauen.
Verwendung
Diese Anweisungen decken nur Änderungen von den Standard Sphinx Anweisungen.
Erstellen Sie eine neue Struktur für Ihr Sphinx Dokumentation, mit sphinx_quickstart, wie in der Einleitung beschrieben Sphinx.
Importieren Sie die stsci_sphinx Anpassungen in Ihr Projekt conf.py indem Sie die folgende Zeile an der Spitze:
von stsci.sphinxext.conf import *
Die Zeile "Erweiterungen" in Ihrem conf.py sollte auch geändert werden, so dass es die von stsci.sphinxext definierten Erweiterungen nicht außer Kraft setzen. Ändern Sie beispielsweise:
Erweiterungen = ['sphinx.ext.autodoc']
zu:
Erweiterungen + = ['sphinx.ext.autodoc']
. Auch, kommentieren Sie die 'html_theme' Linie, so dass Ihr Projekt wird die stsci.sphinxext man verwenden
Anforderungen :
- Python
- Sphinx
- numpydoc
- Matplotlib
Kommentare nicht gefunden