Don't add package name to site_path value in dev_tools/docs/build_api_docs.py#1400
Merged
Conversation
The base `site_path` parameter value is used to construct the absolute URLs for the table of contents and redirects. Past organizations of the DevSite-based API documentation for OpenFermion must have been slightly different. To make things work correctly today, the value of `site_path` in dev_tools/docs/build_api_docs.py must omit the `openfermion` part, because the Python API generator (`tensorflow_docs.api_generator`) automatically appends the Python package's namespace (`openfermion`) to the base `site_path`. This change only affects the metadata links generated in the `_toc.yaml` and `_redirects.yaml` files used for the web site served internally by Google.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the default value of the site_path command-line flag in dev_tools/docs/build_api_docs.py from '/reference/python/openfermion' to '/reference/python'. There are no review comments to address, and I have no feedback to provide on this straightforward change.
mhucka
changed the title
site_pathsite_path value in dev_tools/docs/build_api_docs.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The base
site_pathparameter value is used to construct the absolute URLs for the table of contents and redirects. Past organizations of the DevSite-based API documentation for OpenFermion must have been slightly different. To make things work correctly today, the value ofsite_pathin dev_tools/docs/build_api_docs.py must omit theopenfermionpart, because the Python API generator (tensorflow_docs.api_generator) automatically appends the Python package's namespace (openfermion) to the basesite_path.This change only affects the metadata links generated in the
_toc.yamland_redirects.yamlfiles used for the web site served internally by Google.