summaryrefslogtreecommitdiffstats
path: root/docs/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py116
1 files changed, 116 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..25d002c
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+
+import sys
+import os
+import re
+
+# Prefer to use the version of the theme in this repo
+# and not the installed version of the theme.
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.append(os.path.abspath('./demo/'))
+
+from sphinx_rtd_theme import __version__ as theme_version
+from sphinx_rtd_theme import __version_full__ as theme_version_full
+from sphinx.locale import _
+
+project = u'Read the Docs Sphinx Theme'
+slug = re.sub(r'\W+', '-', project.lower())
+version = theme_version
+release = theme_version_full
+author = u'Dave Snider, Read the Docs, Inc. & contributors'
+copyright = author
+language = 'en'
+
+extensions = [
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.autosummary',
+ 'sphinx.ext.mathjax',
+ 'sphinx.ext.viewcode',
+ 'sphinx_rtd_theme',
+]
+
+templates_path = ['_templates']
+source_suffix = '.rst'
+exclude_patterns = []
+locale_dirs = ['locale/']
+gettext_compact = False
+
+master_doc = 'index'
+suppress_warnings = ['image.nonlocal_uri']
+pygments_style = 'default'
+
+if sys.version_info < (3, 0):
+ tags.add("python2")
+else:
+ tags.add("python3")
+
+intersphinx_mapping = {
+ 'rtd': ('https://docs.readthedocs.io/en/stable/', None),
+ 'rtd-dev': ('https://dev.readthedocs.io/en/stable/', None),
+ 'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+
+html_theme = 'sphinx_rtd_theme'
+html_theme_options = {
+ 'logo_only': True,
+ 'navigation_depth': 5,
+}
+html_context = {}
+
+if not 'READTHEDOCS' in os.environ:
+ html_static_path = ['_static/']
+ html_js_files = ['debug.js']
+
+ # Add fake versions for local QA of the menu
+ html_context['test_versions'] = list(map(
+ lambda x: str(x / 10),
+ range(1, 100)
+ ))
+
+html_logo = "demo/static/logo-wordmark-light.svg"
+html_show_sourcelink = True
+html_favicon = "demo/static/favicon.ico"
+
+htmlhelp_basename = slug
+
+
+latex_documents = [
+ ('index', '{0}.tex'.format(slug), project, author, 'manual'),
+]
+
+man_pages = [
+ ('index', slug, project, [author], 1)
+]
+
+texinfo_documents = [
+ ('index', slug, project, author, slug, project, 'Miscellaneous'),
+]
+
+
+# Extensions to theme docs
+def setup(app):
+ from sphinx.domains.python import PyField
+ from sphinx.util.docfields import Field
+
+ app.add_object_type(
+ 'confval',
+ 'confval',
+ objname='configuration value',
+ indextemplate='pair: %s; configuration value',
+ doc_field_types=[
+ PyField(
+ 'type',
+ label=_('Type'),
+ has_arg=False,
+ names=('type',),
+ bodyrolename='class'
+ ),
+ Field(
+ 'default',
+ label=_('Default'),
+ has_arg=False,
+ names=('default',),
+ ),
+ ]
+ )