conf.py 2.06 KB
Newer Older
Chris Jewell's avatar
Chris Jewell committed
1
2
3
4
5
6
7
8
9
10
11
12
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# 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.
#
Chris Jewell's avatar
Chris Jewell committed
13
14
import os
import sys
15
import sphinx_rtd_theme
Chris Jewell's avatar
Chris Jewell committed
16
17

sys.path.insert(0, os.path.abspath('../..'))
Chris Jewell's avatar
Chris Jewell committed
18

Chris Jewell's avatar
Chris Jewell committed
19

Chris Jewell's avatar
Chris Jewell committed
20
21
22

# -- Project information -----------------------------------------------------

Chris Jewell's avatar
Chris Jewell committed
23
project = 'GEM'
Chris Jewell's avatar
Chris Jewell committed
24
25
26
27
copyright = '2019, Chris Jewell'
author = 'Chris Jewell'

# The full version, including alpha/beta/rc tags
Chris Jewell's avatar
Chris Jewell committed
28
release = '0.1alpha'
Chris Jewell's avatar
Chris Jewell committed
29
30
31
32


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

Chris Jewell's avatar
Chris Jewell committed
33
34
master_doc = 'index'

Chris Jewell's avatar
Chris Jewell committed
35
36
37
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
38
extensions = ['sphinx.ext.autodoc',
39
40
              'sphinx.ext.inheritance_diagram',
              'sphinx_rtd_theme',
41
              'sphinxcontrib.mermaid'
42
              ]
Chris Jewell's avatar
Chris Jewell committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
58
html_theme = 'sphinx_rtd_theme'
59
pygments_style = 'sphinx'
Chris Jewell's avatar
Chris Jewell committed
60
61
62
63

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
64
html_static_path = []
65

66
nitpicky = True