Fixit
Fixit copied to clipboard
Docs to describe updating the docs
I found myself unsure of how to update the docs other than regenerating them with tox -e docs
We should update the README to explain the steps:
- activate the venv
- Run
jupyter notebook
- This will launch a browser window where you can edit the docs directly
- Use "save and checkpoint" -> I think?
- Regenerate the docs with
tox -e docs
@lisroach will try to work on this.
I suggest also mentioning that one should use "Cell -> All Output -> Clear" option before committing (or setting up a pre save hook):
We are dropping the notebook-based docs.