-
Notifications
You must be signed in to change notification settings - Fork 642
Fix Math Rendering in Fidelity Docstring and Enable MathJax for Sphinx Docs #903
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
|
@mhucka Please review these changes when you have a chance. |
|
@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. |
07c857e to
da15406
Compare
|
@mhucka I have removed |
mhucka
left a comment
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.
LGTM
Spotted a problem at the last minute & need to request a minor change.
mhucka
left a comment
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.
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).
Co-authored-by: Michael Hucka <mhucka@google.com>
Co-authored-by: Michael Hucka <mhucka@google.com>
|
@mhucka Thanks , I've accepted the changes. |
…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.
#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!