summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2016-02-07 16:34:46 -0500
committerChris McDonough <chrism@plope.com>2016-02-07 16:34:46 -0500
commitdf7a123a847e2243f38688c033f06200382ba139 (patch)
treecc8e032c2a85d9fee45e68f7f3501046c8bec8ed /docs/conf.py
parent5cd91621668807f9b66811fe57a04fba96e7458a (diff)
parented04017d5a8e82db2e46412f841c55d83ef062b0 (diff)
downloadpyramid-df7a123a847e2243f38688c033f06200382ba139.tar.gz
pyramid-df7a123a847e2243f38688c033f06200382ba139.tar.bz2
pyramid-df7a123a847e2243f38688c033f06200382ba139.zip
Merge branch 'master' of github.com:Pylons/pyramid
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py29
1 files changed, 25 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 8a9bac6ed..a895bc6c3 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -53,12 +53,15 @@ extensions = [
'sphinx.ext.doctest',
'repoze.sphinx.autointerface',
'sphinx.ext.viewcode',
- 'sphinx.ext.intersphinx'
+ 'sphinx.ext.intersphinx',
+ 'sphinxcontrib.programoutput',
+ # enable pylons_sphinx_latesturl when this branch is no longer "latest"
+ # 'pylons_sphinx_latesturl',
]
# Looks for objects in external projects
intersphinx_mapping = {
- 'colander': ( 'http://docs.pylonsproject.org/projects/colander/en/latest', None),
+ 'colander': ('http://docs.pylonsproject.org/projects/colander/en/latest', None),
'cookbook': ('http://docs.pylonsproject.org/projects/pyramid-cookbook/en/latest/', None),
'deform': ('http://docs.pylonsproject.org/projects/deform/en/latest', None),
'jinja2': ('http://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/', None),
@@ -66,8 +69,8 @@ intersphinx_mapping = {
'python': ('http://docs.python.org', None),
'python3': ('http://docs.python.org/3', None),
'sqla': ('http://docs.sqlalchemy.org/en/latest', None),
- 'tm': ('http://docs.pylonsproject.org/projects/pyramid_tm/en/latest/', None),
- 'toolbar': ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None),
+ 'tm': ('http://docs.pylonsproject.org/projects/pyramid-tm/en/latest/', None),
+ 'toolbar': ('http://docs.pylonsproject.org/projects/pyramid-debugtoolbar/en/latest', None),
'tstring': ('http://docs.pylonsproject.org/projects/translationstring/en/latest', None),
'tutorials': ('http://docs.pylonsproject.org/projects/pyramid-tutorials/en/latest/', None),
'venusian': ('http://docs.pylonsproject.org/projects/venusian/en/latest', None),
@@ -123,12 +126,30 @@ if book:
# Options for HTML output
# -----------------------
+# enable pylons_sphinx_latesturl when this branch is no longer "latest"
+# pylons_sphinx_latesturl_base = (
+# 'http://docs.pylonsproject.org/projects/pyramid/en/latest/')
+# pylons_sphinx_latesturl_pagename_overrides = {
+# # map old pagename -> new pagename
+# 'whatsnew-1.0': 'index',
+# 'whatsnew-1.1': 'index',
+# 'whatsnew-1.2': 'index',
+# 'whatsnew-1.3': 'index',
+# 'whatsnew-1.4': 'index',
+# 'whatsnew-1.5': 'index',
+# 'tutorials/gae/index': 'index',
+# 'api/chameleon_text': 'api',
+# 'api/chameleon_zpt': 'api',
+# }
html_theme = 'pyramid'
html_theme_path = pylons_sphinx_themes.get_html_themes_path()
html_theme_options = dict(
github_url='https://github.com/Pylons/pyramid',
+ # on master branch true, else false
in_progress='true',
+ # on previous branches/major releases true, else false
+ outdated='false',
)
# The name for this set of Sphinx documents. If None, it defaults to