stsci.sphinxex

stsci.sphinxext περιέχει επεκτάσεις Σφίγγα για την κατασκευή τεκμηρίωση από STScI.
Χρήση
Οι οδηγίες αυτές καλύπτουν μόνο τις αλλαγές από τις βασικές οδηγίες Σφίγγα.
Δημιουργήστε ένα νέο δέντρο για Σφίγγα τεκμηρίωση σας, χρησιμοποιώντας sphinx_quickstart, όπως περιγράφεται στην εισαγωγή Σφίγγα.
Εισαγάγετε τις προσαρμογές stsci_sphinx σε conf.py του έργου σας, εισάγοντας την ακόλουθη γραμμή στο επάνω μέρος:
από stsci.sphinxext.conf εισαγωγής *
Η «επεκτάσεις» γραμμή conf.py σας θα πρέπει επίσης να τροποποιηθεί ώστε να μην παρακάμπτουν τις επεκτάσεις που ορίζονται από stsci.sphinxext. Για παράδειγμα, να αλλάξετε:
επεκτάσεις = ['sphinx.ext.autodoc »]
για:
επεκτάσεις + = ['sphinx.ext.autodoc »]
. Επίσης, σε σχόλιο τη γραμμή 'html_theme », έτσι ώστε το έργο σας θα χρησιμοποιήσει το stsci.sphinxext ένα

Απαιτήσεις :

• Python
• Σφίγγα
• numpydoc
• Matplotlib