updating sphinx configuration

parent 90988d4d
......@@ -13,6 +13,7 @@ aGrUM-dev.kdev
*.kdev4
src/testunits/.kdev_include_paths
.kdev_include_paths
*.orig
# this file (when existing) is just a helper for IDE : the genuine version is generated by CMAKE in build folder.
src/agrum/config.h
......@@ -71,7 +72,7 @@ apps/pyAgrum/resources/*.dot
apps/pyAgrum/resources/*.csv
# generated by ipython samples and notebooks
# generated by ipython samples, documentation and notebooks
wrappers/pyAgrum/notebooks/out/*.png
wrappers/pyAgrum/notebooks/out/WaterSprinkler.*
wrappers/pyAgrum/notebooks/out/*.csv
......@@ -88,3 +89,4 @@ apps/pyAgrum/samples/roc_alarm.dsl-alarm.csv-KINKEDTUBE-TRUE.png
.idea/
*.swp
*.whl
wrappers/pyAgrum/sphinx/sphinx_warnings.txt
......@@ -2,10 +2,11 @@
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXOPTS = -c . -a -E -w sphinx_warnings.txt
SPHINXBUILD = python3 `which sphinx-build`
PAPER =
BUILDDIR = ../../../build/release/wrappers/pyAgrum/docs
AGRUMBUILDDIR = "{agrum}/build/release/wrappers/pyAgrum/docs"
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
......@@ -52,13 +53,13 @@ clean:
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@echo "Build finished. The HTML pages are in $(AGRUMBUILDDIR)/html."
.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
@echo "Build finished. The HTML pages are in $(AGRUMBUILDDIR)/dirhtml."
.PHONY: singlehtml
singlehtml:
......@@ -130,7 +131,7 @@ epub3:
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Build finished; the LaTeX files are in $(AGRUMBUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
......@@ -139,32 +140,32 @@ latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
@echo "pdflatex finished; the PDF files are in $(AGRUMBUILDDIR)/latex."
.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
@echo "pdflatex finished; the PDF files are in $(AGRUMBUILDDIR)/latex."
.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
@echo "Build finished. The text files are in $(AGRUMBUILDDIR)/text."
.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
@echo "Build finished. The manual pages are in $(AGRUMBUILDDIR)/man."
.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Build finished. The Texinfo files are in $(AGRUMBUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
......@@ -173,13 +174,13 @@ info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
@echo "makeinfo finished; the Info files are in $(AGRUMBUILDDIR)/texinfo."
.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
@echo "Build finished. The message catalogs are in $(AGRUMBUILDDIR)/locale."
.PHONY: changes
changes:
......@@ -210,13 +211,13 @@ coverage:
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
@echo "Build finished. The XML files are in $(AGRUMBUILDDIR)/xml."
.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
@echo "Build finished. The pseudo-XML files are in $(AGRUMBUILDDIR)/pseudoxml."
.PHONY: dummy
dummy:
......
......@@ -503,9 +503,10 @@ def process_signature(app, what, name, obj, options, signature, return_annotatio
def skip(app, what, name, obj, skip, options):
exclusions = ('__weakref__', '__ne__', '__eq__', # special-members
exclusions = ('__weakref__', '__ne__', '__eq__', # special-members
'__doc__', '__module__', '__dict__', # undoc-members
'__swig_destroy__', # swig members
'__swig_destroy__', '_s', # swig members
'__init__' , # swig-managed
'clone', # special members
)
exclude = name in exclusions
......
Random Variables and Potentials
===============================
aGrUM/pyAgrum exclusively uses ploum ploum
aGrUM/pyAgrum is dedicated for discrete probability distribution.
Random Variables
There are 3 types of discrete random variables in aGrUM/pyAgrum : LabelizedVariable, DiscretizedVariable and RangeVariable. The 3 types are mainly provided in order to ease the modelisation. Derived from DiscreteVariable, they share a common API. They essentially differ by the means to create, name and access to their modalities.
Common API for Random Discrete Variables
----------------
.. autoclass:: pyAgrum.DiscreteVariable
:members:
Concrete classes for Random Discrete Variables
----------------
.. autoclass:: pyAgrum.LabelizedVariable
:members:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment