Added more docs

.gitignore

@@ -1,3 +1,3 @@
-doc/_build
+doc/build
 .idea
 */__pycache__

doc/Makefile

@@ -6,7 +6,7 @@
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
-BUILDDIR      = _build
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:

doc/conf.py

@@ -7,19 +7,25 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'fglib2'
-copyright = '2023, Tom Schierenbeck, Abdelrhman Bassiouny'
-author = 'Tom Schierenbeck, Abdelrhman Bassiouny'
+copyright = '2023, Tom Schierenbeck, Abdelrhman Bassiouny, Alessandro Santonicola'
+author = 'Tom Schierenbeck, Abdelrhman Bassiouny, Alessandro Santonicola'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['autoapi.extension',
-              'sphinx_rtd_theme',
-              "nbsphinx",
-              "sphinx_gallery.load_style"]
-
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode',
+    'sphinx_rtd_theme',
+    'autoapi.extension',
+    'nbsphinx',
+    'sphinx_gallery.load_style',
+]
 templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+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

doc/index.rst

@@ -10,7 +10,8 @@ Welcome to fglib2's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   quickstart.rst
+   quickstart
+   walkthrough
 
 
 fglib2 provides a fast and flexible package for creating and manipulating factor graphs.
@@ -21,6 +22,9 @@ While the functionality of the package is similar to the original fglib, the imp
 The topic of factor graphs is best understood through `Phillipp Henning's Lecture on YouTube.
 <https://www.youtube.com/watch?v=fXD6KJB1U20&list=PL05umP7R6ij1tHaOFY96m5uX3J21a6yNd&index=18>`_
 
+For event and variable definitions used in this package, please refer to the documentation and examples from the
+`random_events <https://random-events.readthedocs.io/en/latest/>`_ package.
+
 Installation
 ============
 Install the fglib2 package using pip::

doc/walkthrough.rst

@@ -0,0 +1,12 @@
+Walkthrough the package
+=======================
+
+The fglib2 package contains two modules.
+The first one is the :mod:`fglib2.distributions` module, which contains tabular distributions over `discrete random
+variables. <https://random-events.readthedocs.io/en/latest/#variables>`_. The second one is the :mod:`fglib2.graphs`
+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.