Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup doc config #209

Merged
merged 4 commits into from
Apr 3, 2018
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
MNT: Clean up conf.py
Re-order things to match MetPy a bit more closesly. Also remove/add a
few minor options to match what MetPy does.
  • Loading branch information
dopplershift committed Apr 2, 2018
commit 639906805d16e05a4ea0bbd133419013068aacc1
36 changes: 15 additions & 21 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Siphon documentation build configuration file, created by
# sphinx-quickstart on Wed Apr 22 15:27:44 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
Expand All @@ -16,6 +13,8 @@
import sys
import os

import siphon

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Expand All @@ -37,20 +36,10 @@
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.napoleon',
'sphinx_gallery.gen_gallery',
'sphinx.ext.viewcode'
'sphinx.ext.viewcode',
'sphinx_gallery.gen_gallery'
]

mathjax_path = 'https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
#autosummary_generate = True

# Set up mapping for other projects' docs
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'numpy': ('https://docs.scipy.org/doc/numpy/', None),
'requests': ('http://docs.python-requests.org/en/master/', None),
}

sphinx_gallery_conf = {
'doc_module': ('siphon',),
'reference_url': {
Expand All @@ -70,6 +59,12 @@
'.md': 'recommonmark.parser.CommonMarkParser',
}

# Set up mapping for other projects' docs
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'numpy': ('https://docs.scipy.org/doc/numpy/', None),
'requests': ('http://docs.python-requests.org/en/master/', None),
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -92,9 +87,8 @@
# built documents.
#
# The short X.Y version.
import siphon
verinfo = siphon.__version__
version = verinfo.split('+')[0]
version = verinfo.split('+')[0].rsplit('.', 1)[0]
# The full version, including alpha/beta/rc tags.
release = verinfo

Expand All @@ -114,7 +108,7 @@

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
default_role = 'autolink'

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
Expand Down Expand Up @@ -190,7 +184,7 @@ def setup(app):

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
html_last_updated_fmt = '%b %d, %Y at %H:%M:%S'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
Expand Down Expand Up @@ -281,7 +275,7 @@ def setup(app):
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'Siphon', 'Siphon Documentation',
['Unidata'], 1)
['Siphon Contributors'], 1)
]

# If true, show URL addresses after external links.
Expand All @@ -295,7 +289,7 @@ def setup(app):
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Siphon', 'Siphon Documentation',
'Unidata', 'Siphon', 'One line description of project.',
'Siphon Contributors', 'Siphon', 'One line description of project.',
'Miscellaneous'),
]

Expand Down