Skip to content

Commit

Permalink
Update Documenting Bloqs section with correct notebook location
Browse files Browse the repository at this point in the history
  • Loading branch information
shab5 committed Oct 7, 2024
1 parent 4b425fc commit 31f2e49
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion qualtran/Autodoc.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
"\n",
"This code should be located in the module defining the bloq class.\n",
"\n",
"Each bloq class has one `BloqDocSpec` which may have multiple bloq examples. Each jupyter notebook roughly corresponds to one module or package and can document multiple bloq classes in it, so the final step is to plumb through the `BloqDocSpec` into a `NotebookSpec`. In `dev_tools/autogenerate-bloqs-notebooks-v2.py`, you can add a new `NotebookSpecV2` to the big list or add your `BloqDocSpec` to an existing one. If you execute this script, it will generate a new notebook or new cells in an existing notebook with documentation for your bloq. You may need to manually `git add` the new notebook.\n",
"Each bloq class has one `BloqDocSpec` which may have multiple bloq examples. Each jupyter notebook roughly corresponds to one module or package and can document multiple bloq classes in it, so the final step is to plumb through the `BloqDocSpec` into a `NotebookSpec`. In `dev_tools/qualtran_dev_tools/notebook_specs.py`, you can add a new `NotebookSpecV2` to the big list or add your `BloqDocSpec` to an existing one. If you execute this script, it will generate a new notebook or new cells in an existing notebook with documentation for your bloq. You may need to manually `git add` the new notebook.\n",
"\n",
"\n",
"```python\n",
Expand Down

0 comments on commit 31f2e49

Please sign in to comment.