|
| 1 | +#!/usr/bin/env python3 |
| 2 | +# -*- coding: utf-8 -*- |
| 3 | +# |
| 4 | +# {{ cookiecutter.python_package_name }} documentation build configuration file |
| 5 | +# |
| 6 | +# This file is execfile()d with the current directory set to its |
| 7 | +# containing dir. |
| 8 | +# |
| 9 | +# Note that not all possible configuration values are present in this |
| 10 | +# autogenerated file. |
| 11 | +# |
| 12 | +# All configuration values have a default; values that are commented out |
| 13 | +# serve to show the default. |
| 14 | + |
| 15 | + |
| 16 | +# -- General configuration ------------------------------------------------ |
| 17 | + |
| 18 | +# If your documentation needs a minimal Sphinx version, state it here. |
| 19 | +# |
| 20 | +# needs_sphinx = '1.0' |
| 21 | + |
| 22 | +# Add any Sphinx extension module names here, as strings. They can be |
| 23 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 24 | +# ones. |
| 25 | +extensions = [ |
| 26 | + 'sphinx.ext.autodoc', |
| 27 | + 'sphinx.ext.viewcode', |
| 28 | + 'sphinx.ext.intersphinx', |
| 29 | + 'sphinx.ext.napoleon', |
| 30 | + 'sphinx.ext.todo', |
| 31 | + 'nbsphinx', |
| 32 | + 'jupyter_sphinx.embed_widgets', |
| 33 | + 'nbsphinx_link', |
| 34 | +] |
| 35 | + |
| 36 | +# Ensure our extension is available: |
| 37 | +import sys |
| 38 | +from os.path import dirname, join as pjoin |
| 39 | +docs = dirname(dirname(__file__)) |
| 40 | +root = dirname(docs) |
| 41 | +sys.path.insert(0, root) |
| 42 | +sys.path.insert(0, pjoin(docs, 'sphinxext')) |
| 43 | + |
| 44 | +# Add any paths that contain templates here, relative to this directory. |
| 45 | +templates_path = ['_templates'] |
| 46 | + |
| 47 | +# The suffix(es) of source filenames. |
| 48 | +# You can specify multiple suffix as a list of string: |
| 49 | +# |
| 50 | +# source_suffix = ['.rst', '.md'] |
| 51 | +source_suffix = '.rst' |
| 52 | + |
| 53 | +# The master toctree document. |
| 54 | +master_doc = 'index' |
| 55 | + |
| 56 | +# General information about the project. |
| 57 | +project = '{{ cookiecutter.python_package_name }}' |
| 58 | +copyright = '{% now 'local', '%Y' %}, {{ cookiecutter.author_name }}' |
| 59 | +author = '{{ cookiecutter.author_name }}' |
| 60 | + |
| 61 | +# The version info for the project you're documenting, acts as replacement for |
| 62 | +# |version| and |release|, also used in various other places throughout the |
| 63 | +# built documents. |
| 64 | +# |
| 65 | +# The short X.Y version. |
| 66 | + |
| 67 | + |
| 68 | +# get version from nbdime: |
| 69 | +import os |
| 70 | +here = os.path.dirname(__file__) |
| 71 | +repo = os.path.join(here, '..', '..') |
| 72 | +_version_py = os.path.join(repo, '{{ cookiecutter.python_package_name }}', '_version.py') |
| 73 | +version_ns = {} |
| 74 | +with open(_version_py) as f: |
| 75 | + exec(f.read(), version_ns) |
| 76 | + |
| 77 | +# The short X.Y version. |
| 78 | +version = '%i.%i' % version_ns['version_info'][:2] |
| 79 | +# The full version, including alpha/beta/rc tags. |
| 80 | +release = version_ns['__version__'] |
| 81 | + |
| 82 | +# The language for content autogenerated by Sphinx. Refer to documentation |
| 83 | +# for a list of supported languages. |
| 84 | +# |
| 85 | +# This is also used if you do content translation via gettext catalogs. |
| 86 | +# Usually you set "language" from the command line for these cases. |
| 87 | +language = None |
| 88 | + |
| 89 | +# List of patterns, relative to source directory, that match files and |
| 90 | +# directories to ignore when looking for source files. |
| 91 | +# This patterns also effect to html_static_path and html_extra_path |
| 92 | +exclude_patterns = ['**.ipynb_checkpoints'] |
| 93 | + |
| 94 | +# The name of the Pygments (syntax highlighting) style to use. |
| 95 | +pygments_style = 'sphinx' |
| 96 | + |
| 97 | +# If true, `todo` and `todoList` produce output, else they produce nothing. |
| 98 | +todo_include_todos = False |
| 99 | + |
| 100 | + |
| 101 | +# -- Options for HTML output ---------------------------------------------- |
| 102 | + |
| 103 | + |
| 104 | +# Theme options are theme-specific and customize the look and feel of a theme |
| 105 | +# further. For a list of options available for each theme, see the |
| 106 | +# documentation. |
| 107 | +# |
| 108 | +# html_theme_options = {} |
| 109 | + |
| 110 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 111 | +# relative to this directory. They are copied after the builtin static files, |
| 112 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 113 | +html_static_path = ['_static'] |
| 114 | + |
| 115 | + |
| 116 | +# -- Options for HTMLHelp output ------------------------------------------ |
| 117 | + |
| 118 | +# Output file base name for HTML help builder. |
| 119 | +htmlhelp_basename = '{{ cookiecutter.python_package_name }}doc' |
| 120 | + |
| 121 | + |
| 122 | +# -- Options for LaTeX output --------------------------------------------- |
| 123 | + |
| 124 | +latex_elements = { |
| 125 | + # The paper size ('letterpaper' or 'a4paper'). |
| 126 | + # |
| 127 | + # 'papersize': 'letterpaper', |
| 128 | + |
| 129 | + # The font size ('10pt', '11pt' or '12pt'). |
| 130 | + # |
| 131 | + # 'pointsize': '10pt', |
| 132 | + |
| 133 | + # Additional stuff for the LaTeX preamble. |
| 134 | + # |
| 135 | + # 'preamble': '', |
| 136 | + |
| 137 | + # Latex figure (float) alignment |
| 138 | + # |
| 139 | + # 'figure_align': 'htbp', |
| 140 | +} |
| 141 | + |
| 142 | +# Grouping the document tree into LaTeX files. List of tuples |
| 143 | +# (source start file, target name, title, |
| 144 | +# author, documentclass [howto, manual, or own class]). |
| 145 | +latex_documents = [ |
| 146 | + (master_doc, '{{ cookiecutter.python_package_name }}.tex', '{{ cookiecutter.python_package_name }} Documentation', |
| 147 | + '{{ cookiecutter.author_name }}', 'manual'), |
| 148 | +] |
| 149 | + |
| 150 | + |
| 151 | +# -- Options for manual page output --------------------------------------- |
| 152 | + |
| 153 | +# One entry per manual page. List of tuples |
| 154 | +# (source start file, name, description, authors, manual section). |
| 155 | +man_pages = [ |
| 156 | + (master_doc, |
| 157 | + '{{ cookiecutter.python_package_name }}', |
| 158 | + '{{ cookiecutter.python_package_name }} Documentation', |
| 159 | + [author], 1) |
| 160 | +] |
| 161 | + |
| 162 | + |
| 163 | +# -- Options for Texinfo output ------------------------------------------- |
| 164 | + |
| 165 | +# Grouping the document tree into Texinfo files. List of tuples |
| 166 | +# (source start file, target name, title, author, |
| 167 | +# dir menu entry, description, category) |
| 168 | +texinfo_documents = [ |
| 169 | + (master_doc, |
| 170 | + '{{ cookiecutter.python_package_name }}', |
| 171 | + '{{ cookiecutter.python_package_name }} Documentation', |
| 172 | + author, |
| 173 | + '{{ cookiecutter.python_package_name }}', |
| 174 | + '{{ cookiecutter.project_short_description }}', |
| 175 | + 'Miscellaneous'), |
| 176 | +] |
| 177 | + |
| 178 | + |
| 179 | +# Example configuration for intersphinx: refer to the Python standard library. |
| 180 | +intersphinx_mapping = {'https://docs.python.org/': None} |
| 181 | + |
| 182 | +# Read The Docs |
| 183 | +# on_rtd is whether we are on readthedocs.org, this line of code grabbed from |
| 184 | +# docs.readthedocs.org |
| 185 | +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
| 186 | + |
| 187 | +if not on_rtd: # only import and set the theme if we're building docs locally |
| 188 | + import sphinx_rtd_theme |
| 189 | + html_theme = 'sphinx_rtd_theme' |
| 190 | + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
| 191 | + |
| 192 | +# otherwise, readthedocs.org uses their theme by default, so no need to specify it |
| 193 | + |
| 194 | + |
| 195 | +# Uncomment this line if you have know exceptions in your included notebooks |
| 196 | +# that nbsphinx complains about: |
| 197 | +# |
| 198 | +nbsphinx_allow_errors = True # exception ipstruct.py ipython_genutils |
| 199 | + |
| 200 | + |
| 201 | +def setup(app): |
| 202 | + app.setup_extension('jupyter_sphinx.embed_widgets') |
| 203 | + def add_scripts(app): |
| 204 | + for fname in ['helper.js', 'embed-bundle.js']: |
| 205 | + if not os.path.exists(os.path.join(here, '_static', fname)): |
| 206 | + app.warn('missing javascript file: %s' % fname) |
| 207 | + app.add_javascript(fname) |
| 208 | + app.connect('builder-inited', add_scripts) |
0 commit comments