Skip to content

Generate Documentation

Sayam Kumar edited this page Aug 16, 2021 · 4 revisions

Build documentation locally

Documentation at v3 branch will use the all-time around semantic sphinx theme.

Documentation at main (v4) branch will use pydata_sphinx_theme.

To build the docs, do these at pymc3 root -

$ git checkout <branch-name>  # Checkout the main or v3 branch
$ pip install -r requirements-dev.txt  # Make sure the dev requirements are installed
$ cd docs/source
$ git submodule init
$ git submodule update --remote  # To update pymc-examples submodule (optional step)
$ make html  # Build docs  
$ python -m http.server --directory _build/html  # Render docs

Now, go over to http://127.0.0.1:8000/ in web browser to view the generated docs.

Clone this wiki locally