To compile the documentations on your local machine you will need to install the following dependency in your environment:
# sphinx
pip install sphinx sphinx-autodoc-typehints sphinx_book_theme sphinx-copybutton
# enable Markdown documentation in sphinx
pip install recommonmark
# enable python jupyter notebook in sphinx
pip install nbsphinx nbconvert
# install pandoc
conda install -c conda-forge pandocUnder the root of this repo, execute the following commandline
sphinx-build -b html docs docs/_buildTo browse the documentation on your local machine, you may start a minimal HTTP server with
python3 -m http.server --directory docs/_build 8000In a web browser, e.g. Chrome or Edge, you can read the docs at localhost at port 8000.