Skip to content

Make docs for root bloqs follow the same workflow as other bloqs#1583

Closed
NoureldinYosri wants to merge 9 commits intoquantumlib:mainfrom
NoureldinYosri:_roots
Closed

Make docs for root bloqs follow the same workflow as other bloqs#1583
NoureldinYosri wants to merge 9 commits intoquantumlib:mainfrom
NoureldinYosri:_roots

Conversation

@NoureldinYosri
Copy link
Copy Markdown
Contributor

@NoureldinYosri NoureldinYosri commented Mar 5, 2025

based on our conversation from a few weeks ago @mpharrigan

@mpharrigan
Copy link
Copy Markdown
Collaborator

This pr adds a new file ecc_root.ipynb but doesn't remove ecc.ipynb. I guess the original organization had ecc.ipynb linked twice in the table of contents (TOC). What's the plan for handling this redundant information?

@NoureldinYosri
Copy link
Copy Markdown
Contributor Author

@mpharrigan how about renaming ecc.ipynb to ecc_arithmetic.ipynb? to highlight that that notebook contains the documentation of the bloqs used in doing ECC operations as opposed to the new ecc_root.ipynb which contains only the root bloq

@mpharrigan
Copy link
Copy Markdown
Collaborator

Sure, but there's still the same content copied in both places; namely qualtran.bloqs.cryptography.ecc.find_ecc_private_key._ECC_BLOQ_DOC,

@NoureldinYosri
Copy link
Copy Markdown
Contributor Author

yes, I left it for completeness ... or do you want to remove it?

@mpharrigan
Copy link
Copy Markdown
Collaborator

I'm not sure I have a strong preference either way. I was hoping you had some grand vision for how to organize these applications and subroutines :)

@mpharrigan
Copy link
Copy Markdown
Collaborator

@NoureldinYosri bump

@mpharrigan
Copy link
Copy Markdown
Collaborator

sphinx has the following to say about the situation at present:

checking consistency... /usr/local/google/home/mpharrigan/qualtran/qualtran/docs/bloqs/cryptography/ecc/ecc.ipynb: document is referenced in multiple toctrees: ['bloqs/index', 'bloqs/index'], selecting: bloqs/index <- bloqs/cryptography/ecc/ecc

@mhucka mhucka added the docs Involves documentation label Aug 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Involves documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants