Doc

TODO

@@ -1,7 +1,14 @@
 - [x] Fix “ContinousParametric” and “ContinousParametricProcess” classes API documentation
 - [x] Move "Usage Example" from "User guide" section (user/index.rst) to "Usage" (usage.md) section
-- [ ] Add docstrings to constants. Simply add "///" instead of "//" ? Find how to transfert comments from doxygen xml to breathe
+- [x] Add docstrings to constants. Simply add "///" instead of "//" ? Find how to transfert comments from doxygen xml to breathe
 - [x] Welcome page: better integrate code lines (`pip install...`). Also move section "Note for developpers" into a more appropriated section ?
-- [ ] Move objects description from "tutorials.rst" into "Usage" section
-- [ ] Ensure that warnings are raise is non-existing keyword arguments are used in functions (e.g. Nbiteration in place of NbIteration)
+- [x] Move objects description from "tutorials.rst" into "Usage" section
+- [ ] Check that class members appear in C++ documentation (Reestimation, FrequencyDistribution...)
+- [ ] Check consistency in StatError, StatErrorClass, _StatError, etc. Let them derive from BaseException.
+- [ ] Wrap continuous distributions
+- [ ] Use cross references properly, see "Usage" section
+- [x] Check that definition of vignettes works properly for all notebooks.
+- [ ] Replace hardcoded outputs by outputs of executed code; have doctest extension actually working (see jupyter-sphinx)
+- [ ] Ensure that warnings are raised if non-existing keyword arguments are used in functions (e.g. Nbiteration in place of NbIteration)
 - [ ] Have wrapper documentation be transferred to python module.
+- [ ] Replace hard-coded relative paths by Path().parent etc.

conda/environment.yml

@@ -7,6 +7,7 @@ dependencies:
   - setuptools_scm
   - cmake
   - boost
+  - doxygen
   - matplotlib-base
   - pip
   - pip:

doc/Makefile

@@ -100,6 +100,12 @@ html-noplot: doxygen
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
+.PHONY: html-nodoxygen
+html-nodoxygen:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html. Doxgygen documentation has not been regenerated."
+
 .PHONY: pickle
 pickle: doxygen
 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle

doc/api/index.rst

@@ -1,5 +1,6 @@
 API Reference
 =============
+
 .. toctree::
    :maxdepth: 2
    :caption: AML API: