diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..c747d3f --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,26 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.8" + apt_packages: + - graphviz + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: doc/conf.py + + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: doc/requirements.txt \ No newline at end of file diff --git a/doc/notebooks/distributions.ipynb b/doc/notebooks/distributions.ipynb new file mode 120000 index 0000000..982ebf7 --- /dev/null +++ b/doc/notebooks/distributions.ipynb @@ -0,0 +1 @@ +../../example/distributions.ipynb \ No newline at end of file diff --git a/doc/requirements.txt b/doc/requirements.txt index e69de29..2908769 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -0,0 +1,4 @@ +sphinx_rtd_theme +sphinx-autoapi +nbsphinx +sphinx_gallery \ No newline at end of file diff --git a/doc/walkthrough.rst b/doc/walkthrough.rst index a262027..b148dd5 100644 --- a/doc/walkthrough.rst +++ b/doc/walkthrough.rst @@ -9,4 +9,10 @@ which contains the definition of factor graphs. Distributions ------------- The :mod:`fglib2.distributions` module contains the :class:`fglib2.distributions.Multinomial` class, which implements a -tabular distribution over discrete random variables. The following example highlights the main features of the class. \ No newline at end of file +tabular distribution over discrete random variables. The following example highlights the main features of the class. + + +.. nbgallery:: + + notebooks/distributions +