Skip to content

Conversation

@Aniketsy
Copy link
Contributor

#594
This PR updates the docstring for the fidelity operation to use proper LaTeX block math formatting, ensuring that the fidelity formula renders correctly in the generated documentation.

Additionally, I attempted to add conf.py to enable MathJax in the Sphinx configuration, but I am not fully certain if this change is required or the best approach.

Please let me know if this fix needs any improvements . I’m open to feedback and happy to make changes based on suggestions.
Thankyou!

@Aniketsy
Copy link
Contributor Author

@mhucka Please review these changes when you have a chance.

@mhucka
Copy link
Member

mhucka commented Dec 8, 2025

@Aniketsy Thanks for this. The mathjax changes look good, but the addition of conf.py and sphinx configuration will need to be removed from this PR. The system for generating the live documentation uses a very different workflow (TensorFlow docs) and so conf.py & sphinx are not applicable.

@mhucka mhucka self-assigned this Dec 8, 2025
@Aniketsy
Copy link
Contributor Author

@mhucka I have removed conf.py. Please let me know if this needs further improvement.

mhucka
mhucka previously approved these changes Dec 13, 2025
Copy link
Member

@mhucka mhucka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mhucka mhucka dismissed their stale review December 13, 2025 17:50

Spotted a problem at the last minute & need to request a minor change.

Copy link
Member

@mhucka mhucka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more tiny issue spotted right as I was approving the PR. I used the GitHub "suggestions" feature so that you can just click on the accept button for each change (if you wish).

Aniketsy and others added 2 commits December 13, 2025 23:43
Co-authored-by: Michael Hucka <mhucka@google.com>
Co-authored-by: Michael Hucka <mhucka@google.com>
@Aniketsy
Copy link
Contributor Author

@mhucka Thanks , I've accepted the changes.

@mhucka mhucka merged commit 9a4151b into tensorflow:master Dec 13, 2025
10 checks passed
mhucka pushed a commit to mhucka/quantum that referenced this pull request Dec 14, 2025
…x Docs (tensorflow#903)

Fixes tensorflow#594.

This PR updates the docstring for the fidelity operation to use proper
LaTeX block math formatting, ensuring that the fidelity formula renders
correctly in the generated documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants