Build Documentation

The FlamingPy documentation is built using sphinx. To build the documentation locally, the following packages (some in addition to the packages in the top dev_requirements.txt) are required:

• docutils >= 0.15.2

• m2r2 >= 0.3.2

• matplotlib >= 3.3.3

• networkx >= 2.5

• numba >= 0.53.1

• NumPy >= 1.21.0

• pylint >= 2.13.9

• rustworkx >= 0.12.1

• scipy >= 1.6.0

• sphinx >= 4.3.1

• sphinxcontrib-bibtex >= 0.4.2

• sphinx_autodoc_typehints >= 1.10.3

• sphinx-automodapi >= 0.13

• sphinx-copybutton >= 0.4

• thewalrus >= 0.19.0

• toml >= 0.10.2

All required packages can be installed via:

$ python -m pip install -r doc/dev_requirements.txt

We will build the documentation using make (if you require to install and understand how Makefiles work, see for example this guide). Now to build the HTML documentation, go to the doc directory and run

$ make docs

Note this command will initially run make clean in the directory.

The documentation can be found in the doc/_build/html/ directory.

build_docs

 

Download Python script

 

Download Notebook

 

View on GitHub