stsci.sphinxext 1.1

A set of tools and templates to customize Sphinx for use in STScI projects
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, 13:23 GMT
price:
FREE!
developed by:
Michael Droettboom
homepage:
www.scipy.org
license type:
BSD License 
category:
ROOT \ Documentation

FREE!

In a hurry? Add it to your Download Basket!

user rating

UNRATED
0.0/5
 

0/5

Rate it!

Add your review!

SUBMIT