Fixit icon indicating copy to clipboard operation
Fixit copied to clipboard

Docs to describe updating the docs

Open lisroach opened this issue 3 years ago • 2 comments

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:

  1. activate the venv
  2. Run jupyter notebook
  3. This will launch a browser window where you can edit the docs directly
  4. Use "save and checkpoint" -> I think?
  5. Regenerate the docs with tox -e docs

lisroach avatar Apr 21 '21 17:04 lisroach

@lisroach will try to work on this.

srisatya12 avatar Jun 30 '21 16:06 srisatya12

I suggest also mentioning that one should use "Cell -> All Output -> Clear" option before committing (or setting up a pre save hook): image

Jackenmen avatar Jul 10 '22 18:07 Jackenmen

We are dropping the notebook-based docs.

amyreese avatar Oct 08 '22 00:10 amyreese