Skip to main content

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

Project description

Purpose

This project contains extensions to Sphinx to build documentation from STScI.

Prerequisites

  • Sphinx 0.6.3 or later, and its dependencies
  • numpydoc - provides support for Numpy-style docstring syntax
    • The version shipped with Numpy 1.4.0 or later is required
  • matplotlib - provides matplotlib extensions for inline plotting

These requirements are not listed in the installation requirements in the metadata simply because numpy and matplotlib in particular are large and not easy to deal with, so trying to install a Sphinx theme should not have the side-effect of trying to install these prerequisites as well.

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.

Project details


Release history Release notifications

History Node

1.2.1

This version
History Node

1.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
stsci.sphinxext-1.1.tar.gz (54.8 kB) Copy SHA256 hash SHA256 Source None Aug 31, 2011

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page