The source for BPNet documentation is in this directory under sources/
.
Our documentation uses extended Markdown, as implemented by MkDocs and wrapped by Keras.
- Install MkDocs:
pip install mkdocs
- If you are on OS-x, install
gnu-sed
from conda-forgeconda install -c conda-forge sed
. Make sure thatwhich sed
returns the right path. cd
to thedocs/
folder and run:make build
# Builds a static site in "site" directory- injects the docstrings into placeholders. See
docs/autogen.py
anddocs/templates/api/model.md
- converts the ipynbs (
docs/ipynb_pages.txt
) to .md - Converts the .md files to a static page. See
docs/mkdocs.yml
- injects the docstrings into placeholders. See
mkdocs serve
# Starts a local webserver: localhost:8000