Skip to content

Documentation not accessible.聽#693

Closed

Description

@jerrythomas

The documentation links are all redirected to this repository. The following links are from the readme

All of them redirect to https://github.com/googleapis/google-api-python-client
Even the links for the documentation on Google API client libraries redirects to this repo.

Steps to reproduce

  1. Click on the links in the readme. All of them redirect to this repo.

Samples are actually here
https://github.com/googleapis/google-api-python-client/tree/master/samples

I couldn't find documentation similar to the one for java. Can you correct the links so that the documentation is accessible?

Activity

  1. busunkim96 commented on Jun 11, 2019

    @busunkim96
    Contributor

    Hi @jerrythomas, we're in the process of removing documentation on that site, and have open issues on this repo to add documentation here.

    Thank you for filing an issue!

  2. doransmestad commented on Jun 17, 2019

    @doransmestad

    Any recommendations in the meanwhile? I'd like to use this project to interact with the Google APIs, but no available documentation makes this a bit challenging. Is there a place we can find the documentation while it is being migrated? Thanks

  3. busunkim96 commented on Jun 17, 2019

    @busunkim96
    Contributor

    Hi @doransmestad, if you're looking for the generated ref docs they are currently available under:
    https://googleapis.github.io/google-api-python-client/docs/dyn/{api_name}_{version}

    Examples:
    https://googleapis.github.io/google-api-python-client/docs/dyn/accesscontextmanager_v1beta
    https://googleapis.github.io/google-api-python-client/docs/dyn/customsearch_v1

    For other docs (auth guide, for example), there are currently PRs issues open on this repo that have the contents of those.

    We know this isn't ideal, and we're working on getting the GH pages site up to date.

    Thank you all for your patience!

  4. csudcy commented on Jun 18, 2019

    @csudcy

    Hey @busunkim96, I had a look through PRs but couldn't see any which look like they're for adding docs; it looks like there are some recent merges which update docs though so maybe the links in the root readme just need updating?

    @doransmestad in the meantime, I've found this sample most helpful: https://github.com/googleapis/google-api-python-client/blob/master/samples/appengine/

  5. busunkim96 commented on Jun 18, 2019

    @busunkim96
    Contributor

    My mistake, the docs are currently in issues (labeled type: docs) and all made on June 6th.

    Here's the App Engine one:
    #688

  6. added a commit that references this issue on Jun 26, 2019
    a73a4be
  7. grant commented on Jun 26, 2019

    @grant
    Contributor

    With PR #706, I think we can close this and redirect developers to our new API docs/ pages! 馃帀

    https://github.com/googleapis/google-api-python-client/tree/master/docs

    Pardon with the delay for moving these docs, and let up know if there's anything else we should do.

  8. busunkim96 commented on Jul 17, 2019

    @busunkim96
    Contributor

    Should be closed with #702. There will be more cleanup in the future, but the docs are accessible again. Please see https://github.com/googleapis/google-api-python-client/blob/master/docs/README.md for a list of guides and reference documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

type: docsImprovement to the documentation for an API.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions