google-api-python-client

google-api-python-client copied to clipboard

I'm unable to find an index of the documentation for APIs.

EXPECTED

• Link to this page: http://googleapis.github.io/google-api-python-client/docs/dyn/run_v1alpha1.html

ACTUAL

• Home: https://github.com/googleapis/google-api-python-client
• Doc link: http://googleapis.github.io/google-api-python-client/
• Doc link within docs: http://googleapis.github.io/google-api-python-client/docs/epy/index.html
• Can't find a list of APIs

There's a list at https://github.com/googleapis/google-api-python-client/blob/master/docs/dyn/index.md and it is linked from the docs README https://github.com/googleapis/google-api-python-client/blob/master/docs/README.md.

I've been working on to get all the docs onto googleapis.dev on a different branch. Unfortunately I haven't been able to work on it recently.

I am really confused as to why there are so many doc links:

• http://googleapis.github.io/google-api-python-client/
• (2x) https://github.com/googleapis/google-api-python-client/blob/master/docs/README.md
  • http://googleapis.github.io/google-api-python-client/docs/epy/index.html
  • https://github.com/googleapis/google-api-python-client/blob/master/docs/dyn/index.md
    • http://googleapis.github.io/google-api-python-client/docs/dyn/run_v1.html when I get there, I don't see the same resources/methods like I see with Node.

Ideally I can just quickly find the API I want like I can do with Node:

• https://github.com/googleapis/google-api-nodejs-client
  • https://googleapis.dev/nodejs/googleapis/latest/
    • https://googleapis.dev/nodejs/googleapis/latest/run/index.html

I think there are two issues with the docs that have been touched on here:

Content: The API-specific docs can't be generated with the usual tool (sphinx) because classes are generated at runtime. There's a small script that combines the contents of the discovery doc and the generated code into the format you see at http://googleapis.github.io/google-api-python-client/docs/dyn/run_v1.html.

We can modify the script if folks think it is very hard to use, but there are no plans to do so right now.

Location: The API-specific docs are hard to get to right now. In the long-run, I'm reorganizing the docs to all be published at googleapis.dev. In the short term, I'll open a PR to get the list on the top-level README.

Thanks for the feedback!

Thanks for listening, hope these changes will improve the doc experience for our devs!

We recommend using the newer Google Cloud Client Libraries where available, For Cloud Run, the library can be found here: https://github.com/googleapis/python-run

We are still working on improving our documentation overall.