-
Notifications
You must be signed in to change notification settings - Fork 83
Rename factoring -> cryptograph and create a Root Bloqs docs section #1532
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
| # -------------------------------------------------------------------------- | ||
| # ----- Root Bloqs ----------------------------------------------------- | ||
| # -------------------------------------------------------------------------- | ||
| ROOT_BLOQS = ['cryptography/ecc/ecc.ipynb'] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why can't these be bloq notebooks like the rest of the bloq notebooks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't understand the comment. this is an existing bloq notebook and I'm just putting a second link to it in the new section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The idiomatic way to include bloq documentation in the TOC is by adding a NotebookSpecV2 to the correct section List[NotebookSpecV2]. Each section list is added to NB_BY_SECTION: Dict[str, List[...]]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes I get that and that notebook is already there
Qualtran/dev_tools/qualtran_dev_tools/notebook_specs.py
Lines 557 to 565 in 89e916e
| NotebookSpecV2( | |
| title='Elliptic Curve Cryptography', | |
| module=qualtran.bloqs.cryptography.ecc, | |
| bloq_specs=[ | |
| qualtran.bloqs.cryptography.ecc.find_ecc_private_key._ECC_BLOQ_DOC, | |
| qualtran.bloqs.cryptography.ecc.ec_phase_estimate_r._EC_PE_BLOQ_DOC, | |
| qualtran.bloqs.cryptography.ecc.ec_add_r._ECC_ADD_R_BLOQ_DOC, | |
| qualtran.bloqs.cryptography.ecc.ec_add_r._EC_WINDOW_ADD_BLOQ_DOC, | |
| ], |

factoring/contains code for bothECCandRSAso a better name for it iscryptographyRoot Bloqswith the first one beingFindECCPrivateKeywhich already exists