Skip to content

Commit

Permalink
Update Sphinx config based on upstream astropy/package-template
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph Long committed Aug 9, 2017
1 parent 7be57f6 commit d75d3aa
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
18 changes: 12 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,23 +42,27 @@
from astropy_helpers.sphinx.conf import *

# Get configuration information from setup.cfg
from distutils import config
conf = config.ConfigParser()
try:
from ConfigParser import ConfigParser
except ImportError:
from configparser import ConfigParser
conf = ConfigParser()

conf.read([os.path.join(os.path.dirname(__file__), '..', 'setup.cfg')])
setup_cfg = dict(conf.items('metadata'))

# -- General configuration ----------------------------------------------------

# By default, highlight as Python 3.
highlight_language = 'python3'

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.2'

# To perform a Sphinx version check that needs to be more specific than
# major.minor, call `check_sphinx_version("x.y.z")` here.
# check_sphinx_version("1.2.1")

# Remove buggy astropy extension
extensions.remove('astropy_helpers.sphinx.ext.astropyautosummary')

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns.append('_templates')
Expand All @@ -72,7 +76,6 @@

# This does not *have* to match the package name, but typically does
project = setup_cfg['package_name']
author = setup_cfg['author']
author = u'Association of Universities for Research in Astronomy'
copyright = '{0}, {1}'.format(
datetime.datetime.now().year, author)
Expand Down Expand Up @@ -170,3 +173,6 @@

edit_on_github_source_root = ""
edit_on_github_doc_root = "docs"

# -- Resolving issue number to links in changelog -----------------------------
github_issues_url = 'https://github.com/{0}/issues/'.format(setup_cfg['github_project'])
2 changes: 1 addition & 1 deletion docs/fitsheaders.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _fitsheaders:

POPPY FITS Header Keywords Definitions
=============
======================================


* `WAVELEN`: Wavelength in meters
Expand Down

0 comments on commit d75d3aa

Please sign in to comment.