|
| 1 | +# Configuration file for the Sphinx documentation builder. |
| 2 | +# |
| 3 | +# For the full list of built-in configuration values, see the documentation: |
| 4 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html |
| 5 | + |
| 6 | +# -- Path setup -------------------------------------------------------------- |
| 7 | + |
| 8 | +# If extensions (or modules to document with autodoc) are in another directory, |
| 9 | +# add these directories to sys.path here. If the directory is relative to the |
| 10 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
| 11 | +# |
| 12 | +import os |
| 13 | +import sys |
| 14 | +sys.path.insert(0, os.path.abspath('../..')) |
| 15 | + |
| 16 | +# -- Project information ----------------------------------------------------- |
| 17 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information |
| 18 | + |
| 19 | +project = 'Optibess algorithm' |
| 20 | +copyright = '2023, Elmor Renewable Energies dev team' |
| 21 | +author = 'Elmor Renewable Energies dev team' |
| 22 | +release = '0.1.0' |
| 23 | + |
| 24 | +# -- General configuration --------------------------------------------------- |
| 25 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration |
| 26 | + |
| 27 | +extensions = [ |
| 28 | + 'sphinx.ext.napoleon', |
| 29 | + 'sphinx.ext.autodoc', |
| 30 | + 'sphinx.ext.viewcode', |
| 31 | +] |
| 32 | + |
| 33 | +templates_path = ['_templates'] |
| 34 | +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 35 | +autodoc_content = 'both' |
| 36 | +autodoc_member_order = 'bysource' |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | +# -- Options for HTML output ------------------------------------------------- |
| 41 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output |
| 42 | + |
| 43 | +html_theme = 'sphinx_rtd_theme' |
| 44 | +html_static_path = ['_static'] |
0 commit comments