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!: retrieve all markdown pages #266

Closed dandhlee closed 2 years ago

dandhlee commented 2 years ago

Recovered all markdown pages in nested directory structures. This was not correctly retrieved as I was only looking in the top directory.

Few things that's happening (happy to break down, but was hard to do so to have all the moving parts in one picture):

Only the handwritten TOC is updated and works as expected, gapic-combo and gapic-auto doesn't contain any markdown pages in nested directories.

Some markdown pages might come with a mix of handwritten guides and autogenerated API content. I plan on working with the library maintainers to have this updated throughout (<10) for the purpose of this plugin that separates Sphinx HTML and DocFX YAML content.

Breaking Change: Upgrading to using 3.9. All Python client libraries are able to use 3.9, so this is not a problem, but will be a backwards incompatible change.

Fixes #217.

dandhlee commented 2 years ago

Please take a look again!

dandhlee commented 2 years ago

Please take a look again!