Skip to content

Fix additional API documentation bugs#1395

Merged
mhucka merged 4 commits into
quantumlib:mainfrom
mhucka:update-book-yaml
Jul 1, 2026
Merged

Fix additional API documentation bugs#1395
mhucka merged 4 commits into
quantumlib:mainfrom
mhucka:update-book-yaml

Conversation

@mhucka

@mhucka mhucka commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

The last refresh to quantumai.google changed some details needed in the docs/_book.yaml file.

This PR also fixes some broken LaTeX math formatting in a few docstrings.

mhucka added 4 commits June 30, 2026 23:52
The last refresh to quantumai.google did away with
`/_book/menu_software.yaml`.
The structure of website is now such that the upper_tabs value has
changed.
@mhucka
mhucka marked this pull request as ready for review July 1, 2026 04:00

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation book configuration to rename the 'Software' tab to 'OpenFermion' and updates its path. Additionally, it standardizes the math block formatting in several docstrings across the codebase, converting Sphinx-style math directives to standard Markdown/LaTeX syntax ($ and $$) and ensuring proper raw string prefixes (r""") are used where backslashes are present. There are no review comments, so I have no feedback to provide.

@mhucka
mhucka merged commit 31ada15 into quantumlib:main Jul 1, 2026
23 checks passed
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.

1 participant