Skip to content

Commit

Permalink
Added more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tomsch420 committed Oct 27, 2023
1 parent b25cf4e commit 1cf4681
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 1 deletion.
26 changes: 26 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions doc/notebooks/distributions.ipynb
4 changes: 4 additions & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
sphinx_rtd_theme
sphinx-autoapi
nbsphinx
sphinx_gallery
8 changes: 7 additions & 1 deletion doc/walkthrough.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
tabular distribution over discrete random variables. The following example highlights the main features of the class.


.. nbgallery::

notebooks/distributions

0 comments on commit 1cf4681

Please sign in to comment.