diff options
author | alyx <alyx@aleteoryx.me> | 2023-12-24 02:25:26 -0500 |
---|---|---|
committer | alyx <alyx@aleteoryx.me> | 2023-12-24 02:25:26 -0500 |
commit | 48f62aba8db8efe3a109837cda52d04b1b9aad5b (patch) | |
tree | 7e1c810c48ff6707de7aa044d9ec87e15ae11178 /docs/conf.py | |
parent | e21e42e832e4ac633a9d48f6e30c34a9011008bc (diff) | |
download | bbss.py-48f62aba8db8efe3a109837cda52d04b1b9aad5b.tar.gz bbss.py-48f62aba8db8efe3a109837cda52d04b1b9aad5b.tar.bz2 bbss.py-48f62aba8db8efe3a109837cda52d04b1b9aad5b.zip |
Fixed import cycle, began on docs.
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..a851995 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,35 @@ +import sys +import pathlib + +sys.path.append(str(pathlib.PurePath(__file__).parent.parent.joinpath('src'))) +print(sys.path) + + +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'bbss.py' +copyright = '2023, Aleteoryx' +author = 'Aleteoryx' +release = '0.1.0' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ['sphinx.ext.autodoc'] + +templates_path = ['_templates'] +exclude_patterns = ['*~'] + +autodoc_default_options = { "members": None } + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'sphinxdoc' +html_static_path = ['_static'] |