diff options
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..a5c8dca --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,69 @@ +# 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. + +def _add_paths(): + import os + import sys + + sys.path.insert(0, os.path.abspath('..')) + +_add_paths() + +# -- Project information ----------------------------------------------------- + +project = 'thembed' +copyright = '2019, Thomas Touhey' +author = 'Thomas Touhey' + +# The full version, including alpha/beta/rc tags + +def _get_release(): + from os.path import dirname, join, normpath + from pkg_resources import Environment as _Environment + + module_path = normpath(join(dirname(__file__), '..')) + env = _Environment(module_path) + env.scan() + mod = env['thembed'][0] + return mod.version + +release = _get_release() + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc' +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = [] + +# 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 = ['_build', 'Thumbs.db', '.DS_Store', '.goutput*'] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# 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". +html_static_path = [] |