diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..223539d --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,30 @@ +# 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 = 'sparsecoding' +copyright = '2024, RCTN' +author = 'RCTN' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + 'sphinx.ext.napoleon', + 'sphinx.ext.autodoc', +] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'pydata_sphinx_theme' +html_static_path = ['_static'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..f56e6c1 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,21 @@ +.. sparsecoding documentation master file, created by + sphinx-quickstart on Fri Nov 15 13:23:58 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +sparsecoding documentation +========================== + +Add your content using ``reStructuredText`` syntax. See the +`reStructuredText `_ +documentation for details. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + sparsecoding + sparsecoding.data + sparsecoding.priors + modules + diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..b0a77ce --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +pydata-sphinx-theme \ No newline at end of file