The current deployed docs

You can check out the statically hosted build here.

Adding to the docs

How-To work

gitflow

• Fork, clone, checkout development, checkout -b topic, push, PR - link to docs when created -

Setup Jupyter-book

Steps I took for Ubuntu 18

Setup and start a virtual environment to keep everything tidy. apt install python3-venv

You could use conda or whatever you want here. python3 -m venv .cistemdocs Activate the environment (will depend on your env software obviously) source .cistemdocs/bin/activate

pip install --upgrade pip

You may not need to uninstall wheel. I had some funny error. pip uninstall wheel

Install remaining dependencies pip install wheel contextvars numpy matplotlib

Finally install jupyter-book pip install -U jupyter-book

To build (--all arg is optional, but it seems like some changes are not observered leading to no new build?)

jupyter-book build --all cisTEM_docs && firefox cisTEM_docs/_build/html/index.html