googleapis / sphinx-docfx-yaml

Forked sphinx-docfx-yaml repository for creating DocFX YAML for Python Client Libraries
Apache License 2.0
5 stars 7 forks source link

feat: grab repository metadata #364

Closed dandhlee closed 7 months ago

dandhlee commented 7 months ago

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.json file directly to source this information - Sphinx has very limited ways to deliver this information through docs/conf.py.

Based on the googleapis/ repo search, it seems that using name suffices 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 using name instead of api_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.