feat: grab repository metadata #364
Merged
Conversation
This file contains 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
product-auto-label
bot
added
size: m
dansaadati
approved these changes
Mar 30, 2024
docfx_yaml/extension.py
Outdated
| @@ -2086,9 +2106,11 @@ def convert_module_to_package_if_needed(obj): | |||
| file_name_set.add(filename) | |||
|
|
|||
| for entry in yaml_data: | |||
| if not app.env.library_shortname: | |||
| continue | |||
There was a problem hiding this comment.
This would apply to the whole library, right? If so, I think you can just break instead of continue.
There was a problem hiding this comment.
You're right, done.
docfx_yaml/extension.py
Outdated
| @@ -26,6 +26,7 @@ | |||
| import shutil | |||
| import black | |||
| import logging | |||
| import json | |||
There was a problem hiding this comment.
Done. I was able to sort through the first party libraries.
dandhlee
commented
Apr 1, 2024
docfx_yaml/extension.py
Outdated
| @@ -26,6 +26,7 @@ | |||
| import shutil | |||
| import black | |||
| import logging | |||
| import json | |||
There was a problem hiding this comment.
Done. I was able to sort through the first party libraries.
docfx_yaml/extension.py
Outdated
| @@ -2086,9 +2106,11 @@ def convert_module_to_package_if_needed(obj): | |||
| file_name_set.add(filename) | |||
|
|
|||
| for entry in yaml_data: | |||
| if not app.env.library_shortname: | |||
| continue | |||
There was a problem hiding this comment.
You're right, done.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I've noticed an issue with the rest of the libraries not being able to properly find the library names from the given Sphinx info.
Seems like I need to extract the
.repo-metadata.jsonfile directly to source this information - Sphinx has very limited ways to deliver this information throughdocs/conf.py.Based on the
googleapis/repo search, it seems that usingnamesuffices for shortname for the library. If I encounter ones that don't work, I'll create an exception around those few. I've sampled ~100 and seems to work with usingnameinstead ofapi_shortname.Verified that existing library generation demo for bigframes and logging still works.
If the repository metadata could not be retrieved, skip over getting the summary page details.
Fixes b/331977022.