Building Docs

Building docs requires the jupyter-book and the sphinx-autoapi package which is by default not present in the environment file. To install the package, please visit the documentation- https://jupyterbook.org/en/stable/start/overview.html#install-jupyter-book and https://sphinx-autoapi.readthedocs.io/en/latest/

To build the documentation, move to the root of the application and do-

jupyter-book build --all docs

Note

A docs workflow automatically runs on main branch whenever docs are updated and updates documentation here- deepthought-initiative.github.io/pacmanweb/