stsci.sphinxext zawiera rozszerzenia Sfinksa budować dokumentację ze Space Telescope Science Institute.
Zastosowanie
Instrukcje te obejmują jedynie zmiany w standardowych instrukcji Sphinx.
Tworzenie nowego drzewa w dokumentacji Sphinx, przy użyciu sphinx_quickstart, jak opisano we wstępie Sphinx.
Importowania dostosowań stsci_sphinx na język conf.py Twojego projektu wstawiając następujący wiersz na górze:
z stsci.sphinxext.conf import *
Linia "Rozszerzenia" w conf.py powinny również zostać zmienione tak, aby nie przesłonić rozszerzenia zdefiniowane przez stsci.sphinxext. Na przykład, zmienić:
Rozszerzenia = ['sphinx.ext.autodoc']
do:
Rozszerzenia + = ['sphinx.ext.autodoc']
. Ponadto, skomentuj linię "html_theme", więc projekt będzie używać stsci.sphinxext jeden
Wymagania :
- Python
- Sphinx
- numpydoc
- matplotlib
Komentarze nie znaleziono