stsci.sphinxext 1.1

A set of tools and templates to customize Sphinx for use in STScI projects

  Add it to your Download Basket!

 Add it to your Watch List!

0/5

Rate it!
send us
an update
LICENSE TYPE:
BSD License 
USER RATING:
UNRATED
  0.0/5
DEVELOPED BY:
Michael Droettboom
HOMEPAGE:
www.scipy.org
CATEGORY:
ROOT \ Documentation
stsci.sphinxext contains Sphinx extensions to build documentation from STScI.

Usage

These instructions only cover changes from the standard Sphinx instructions.

Create a new tree for your Sphinx documentation, using sphinx_quickstart, as described in the Sphinx introduction.

Import the stsci_sphinx customizations into your project's conf.py by inserting the following line at the top:

from stsci.sphinxext.conf import *

The "extensions" line in your conf.py should also be modified so it doesn't override the extensions defined by stsci.sphinxext. For example, change:

extensions = ['sphinx.ext.autodoc']

to:

extensions += ['sphinx.ext.autodoc']

Also, comment out the 'html_theme' line, so your project will use the stsci.sphinxext one.

Last updated on September 2nd, 2011

requirements

#build documentation #Sphinx extensions #STScI #documentation #builder #Sphinx

Add your review!

SUBMIT