Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 824 Bytes

README.md

File metadata and controls

22 lines (18 loc) · 824 Bytes

To generate the source/causallib.* files run:

sphinx-apidoc -o source ../causallib --separate --force

(from within this directory)

To generate html build run:

make html

requirements

  • sphinx v2.1.0: to generate documentation
  • m2r v0.2.1: to support inline inclusion of the modules' README markdown files
  • nbsphinx v0.4.2: to support inclusion of Jupyter Notebooks inside the html documentation

requirement.txt is a requirement file necessary for readthedocs.org build. Pointed by ../.readthedocs.yml configuration file.

The source/conf.py file also includes some arbitrary code for the automatic inclusion of README files within the documentation.