|
| 1 | +# Configuration file for the Sphinx documentation builder. |
| 2 | +# |
| 3 | +# This file only contains a selection of the most common options. For a full |
| 4 | +# list see the documentation: |
| 5 | +# http://www.sphinx-doc.org/en/master/config |
| 6 | + |
| 7 | +# -- Path setup -------------------------------------------------------------- |
| 8 | + |
| 9 | +# If extensions (or modules to document with autodoc) are in another directory, |
| 10 | +# add these directories to sys.path here. If the directory is relative to the |
| 11 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
| 12 | +# |
| 13 | +import os |
| 14 | +import sys |
| 15 | +sys.path.insert(0, os.path.abspath('..')) |
| 16 | + |
| 17 | + |
| 18 | +# -- Project information ----------------------------------------------------- |
| 19 | + |
| 20 | +project = 'BEAMS' |
| 21 | +copyright = '2019, Ralf Weber' |
| 22 | +author = 'Ralf Weber' |
| 23 | + |
| 24 | +# The full version, including alpha/beta/rc tags |
| 25 | +release = '0.1.0' |
| 26 | + |
| 27 | + |
| 28 | +# -- General configuration --------------------------------------------------- |
| 29 | + |
| 30 | +# Add any Sphinx extension module names here, as strings. They can be |
| 31 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 32 | +# ones. |
| 33 | +extensions = [ |
| 34 | + 'sphinx.ext.autodoc', |
| 35 | + 'sphinx.ext.doctest', |
| 36 | + 'sphinx.ext.viewcode', |
| 37 | + 'sphinx.ext.napoleon', |
| 38 | + 'sphinx.ext.todo', |
| 39 | + 'sphinx.ext.mathjax' |
| 40 | +] |
| 41 | + |
| 42 | +# Add any paths that contain templates here, relative to this directory. |
| 43 | +templates_path = ['_templates'] |
| 44 | + |
| 45 | +# The master toctree document. |
| 46 | +master_doc = 'index' |
| 47 | + |
| 48 | +# List of patterns, relative to source directory, that match files and |
| 49 | +# directories to ignore when looking for source files. |
| 50 | +# This pattern also affects html_static_path and html_extra_path. |
| 51 | +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 52 | + |
| 53 | + |
| 54 | +# -- Options for HTML output ------------------------------------------------- |
| 55 | + |
| 56 | +# The theme to use for HTML and HTML Help pages. See the documentation for |
| 57 | +# a list of builtin themes. |
| 58 | +# |
| 59 | +html_theme = 'sphinx_rtd_theme' |
| 60 | + |
| 61 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 62 | +# relative to this directory. They are copied after the builtin static files, |
| 63 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 64 | +html_static_path = ['_static'] |
0 commit comments