Version the docs #472

ptone · 2014-12-29T04:18:47Z

The docs at http://googlecloudplatform.github.io/gcloud-python/datastore-api.html document the current API at git head - and include a version tag of 0.3.0

This matches the current released version on pypi (that does not have the recent change for implicit credentials)

Please consider using something like readthedocs and provide versioned docs - so that what users find actually matches what they are likely to install :)

Or at least mark the version in master as -dev with a warning in docs, and tag to stable version in a branch.

dhermes · 2014-12-29T04:24:00Z

Thanks for the suggestion @ptone, we've had some other great docs feedback lately. Hopefully we can reach a more stable API soon and versions will become more meaningful.

I think first and foremost, not building docs from HEAD should be done.

silvolu · 2014-12-30T18:38:39Z

My bad, I left in the version string without providing a version history. I think it's fine to build from master, as long as it's properly built in a -dev version as suggested by @ptone (and that is what we do with gcloud-node where we have a master version).
I'll fix it.

yjkogan · 2015-01-30T19:32:53Z

+1 for this. I'm starting reading source code at the specific commit / tag in order to know what's supported in that version.

rstuart85 · 2015-02-05T05:56:19Z

+1 for this. The coding example under Getting Started for Storage doesn't work because the signature for get_buckets() has changed. This is really confusing because the docs say 0.3.0 which matches the version on PyPi as already pointed out. The only way to figure it out is the read the source code which probably isn't ideal.

dhermes · 2015-02-06T21:21:44Z

Something like http://googlecloudplatform.github.io/gcloud-node/#/docs/history is preferred so hopefully we can borrow from gcloud-node

@silvolu you mentioned you had started this, do you have any half-finished work to go from?

silvolu · 2015-02-06T21:24:30Z

@dhermes I mentioned I would start this, but then I got side tracked, so nope, I got nothing :/

dhermes · 2015-02-07T00:06:13Z

@rstuart85 in the short term https://github.com/GoogleCloudPlatform/gcloud-python/releases/tag/v0.4.0 means the docs reflect the latest version on PyPI. I'm hoping to resolve this issue soon-ish.

dhermes · 2015-02-12T19:37:40Z

Starting on this right now.

Fixes googleapis#472.

rstuart85 · 2015-02-12T22:16:51Z

@dhermes great news!

Fixes googleapis#472.

dhermes · 2015-02-14T02:16:05Z

Release pushed but new docs didn't build:
https://travis-ci.org/GoogleCloudPlatform/gcloud-python/builds/50716542

"Not in master on a non-pull request. Doing nothing."

Me thinks "${TRAVIS_BRANCH}" == "master" fails when pushing a tag. I'll have to play around and address this.

Relates to googleapis#472

Fixes googleapis#472. (This is the last piece needed after googleapis#625 and googleapis#662)

…leapis#472)

* Generate google-cloud-bigquery-storage library using synthtool. (#472) * Add simple system test for BigQuery Storage API (#473) * Add simple system test for BigQuery Storage API For the system tests to run correctly, an unreleased version of api_core is required. Updates the setup.py file to indicate the minimum version. * Remove mock dependency and unnecessary imports. * Use -e for local deps. * Add manual client for BigQuery Storage (#474) * Add manual client for BigQuery Storage. The manual client adds a default project, which is used by the wrapped create_read_session to make the project parameter optional. A future purpose of the manual client is to override the read_rows method to return an iterator that can reconnect with the correct offset, much like Spanner's StreamedResultSet class. This work is not yet complete. I'd like feedback on the approach for the manual client first. * Use same client name as wrapped gapic class. * Use subclass for BigQueryStorageClient Also, change create_read_session project argument back to 'parent' to better match the super class. * Add unit tests. * Remove default project from manual client. * Use project_id fixture in system tests. * Regenerate google-cloud-bigquery-storage (#475) * Regenerate google-cloud-bigquery-storage * Re-synthed * Handwritten reader to reconnect on ReadRows streams (#477) * WIP: reader to reconnect on ReadRows streams * Add method to copy a StreamPosition. * Add unit tests for hand-written reader module. * Add docs for new hand-written module. * Add fastavro to root intersphinx * Add ServiceUnavailable to list of resumable exceptions. Pull in .coveragerc file from upstream google-cloud-python.

* Generate google-cloud-bigquery-storage library using synthtool. (googleapis#472) * Add simple system test for BigQuery Storage API (googleapis#473) * Add simple system test for BigQuery Storage API For the system tests to run correctly, an unreleased version of api_core is required. Updates the setup.py file to indicate the minimum version. * Remove mock dependency and unnecessary imports. * Use -e for local deps. * Add manual client for BigQuery Storage (googleapis#474) * Add manual client for BigQuery Storage. The manual client adds a default project, which is used by the wrapped create_read_session to make the project parameter optional. A future purpose of the manual client is to override the read_rows method to return an iterator that can reconnect with the correct offset, much like Spanner's StreamedResultSet class. This work is not yet complete. I'd like feedback on the approach for the manual client first. * Use same client name as wrapped gapic class. * Use subclass for BigQueryStorageClient Also, change create_read_session project argument back to 'parent' to better match the super class. * Add unit tests. * Remove default project from manual client. * Use project_id fixture in system tests. * Regenerate google-cloud-bigquery-storage (googleapis#475) * Regenerate google-cloud-bigquery-storage * Re-synthed * Handwritten reader to reconnect on ReadRows streams (googleapis#477) * WIP: reader to reconnect on ReadRows streams * Add method to copy a StreamPosition. * Add unit tests for hand-written reader module. * Add docs for new hand-written module. * Add fastavro to root intersphinx * Add ServiceUnavailable to list of resumable exceptions. Pull in .coveragerc file from upstream google-cloud-python.

…cp/templates/python_library/.kokoro (#472) Source-Link: googleapis/synthtool@b4fe62e Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:3bf87e47c2173d7eed42714589dc4da2c07c3268610f1e47f8e1a30decbfc7f1 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Source-Link: https://togithub.com/googleapis/synthtool/commit/92006bb3cdc84677aa93c7f5235424ec2b157146 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:2e247c7bf5154df7f98cce087a20ca7605e236340c7d6d1a14447e5c06791bd6

* docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: googleapis/googleapis@8a085ae Source-Link: googleapis/googleapis-gen@b2ab4b0 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Source-Link: https://togithub.com/googleapis/synthtool/commit/25083af347468dd5f90f69627420f7d452b6c50e Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:e6cbd61f1838d9ff6a31436dfc13717f372a7482a82fc1863ca954ec47bff8c8

updating typo from dialogvlow_v2 to dialogflow_v2

…v3.11.2 (#472)

Source-Link: googleapis/synthtool@56da63e Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:993a058718e84a82fda04c3177e58f0a43281a996c7c395e0a56ccc4d6d210d7

Source-Link: googleapis/synthtool@7197a00 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:c43f1d918bcf817d337aa29ff833439494a158a0831508fda4ec75dc4c0d0320 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

…ic enums (#472) * feat: enable "rest" transport in Python for services supporting numeric enums PiperOrigin-RevId: 508143576 Source-Link: googleapis/googleapis@7a702a9 Source-Link: googleapis/googleapis-gen@6ad1279 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNmFkMTI3OWMwZTdhYTc4N2FjNmI2NmM5ZmQ0YTIxMDY5MmVkZmZjZCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * add rest to tests * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <[email protected]>

…cp/templates/python_library/.kokoro (#472) Source-Link: googleapis/synthtool@b4fe62e Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:3bf87e47c2173d7eed42714589dc4da2c07c3268610f1e47f8e1a30decbfc7f1 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

silvolu self-assigned this Dec 30, 2014

dhermes added the documentation label Dec 30, 2014

silvolu mentioned this issue Jan 13, 2015

Remove "Python" from top section of docs and make section much smaller. #538

Closed

jgeewax modified the milestone: Core Stable Jan 30, 2015

dhermes mentioned this issue Feb 3, 2015

Code changes are not reflected in Pypi package #592

Closed

dhermes assigned dhermes and unassigned silvolu Feb 12, 2015

dhermes added a commit to dhermes/google-cloud-python that referenced this issue Feb 12, 2015

Adding subdirectories for versioned docs.

d54759b

Fixes googleapis#472.

dhermes mentioned this issue Feb 12, 2015

Adding subdirectories for versioned docs. #625

Merged

dhermes added a commit to dhermes/google-cloud-python that referenced this issue Feb 12, 2015

Adding subdirectories for versioned docs.

a5aabf3

Fixes googleapis#472.

dhermes mentioned this issue Feb 13, 2015

Make it easy to open a documentation bug from the docs themselves #98

Closed

dhermes closed this as completed in #625 Feb 13, 2015

dhermes reopened this Feb 14, 2015

dhermes mentioned this issue Feb 14, 2015

Making sure new docs get built on tags. #645

Merged

dhermes added a commit to dhermes/google-cloud-python that referenced this issue Feb 18, 2015

Adding update stage for static versions page in docs.

bee3745

Relates to googleapis#472

dhermes added a commit to dhermes/google-cloud-python that referenced this issue Feb 18, 2015

Adding update stage for static versions page in docs.

fd0e143

Relates to googleapis#472

dhermes mentioned this issue Feb 18, 2015

Adding update stage for static versions page in docs. #662

Merged

dhermes added a commit to dhermes/google-cloud-python that referenced this issue Feb 20, 2015

Adds link to versions on every doc page.

2324112

Fixes googleapis#472. (This is the last piece needed after googleapis#625 and googleapis#662)

dhermes mentioned this issue Feb 20, 2015

Adds link to versions on every doc page. #674

Merged

dhermes closed this as completed in #674 Feb 24, 2015

theacodes unassigned dhermes Sep 28, 2018

tswast added a commit to tswast/google-cloud-python that referenced this issue Nov 29, 2018

Generate google-cloud-bigquery-storage library using synthtool. (goog…

a8b4453

…leapis#472)

yoshi-automation added 🚨 This issue needs some love. triage me I really want to be triaged. labels Apr 7, 2020

JustinBeckwith assigned dhermes Feb 1, 2021

vchudnov-g pushed a commit that referenced this issue Sep 20, 2023

docs: fix typos in UPGRADING.md (#472)

74a8b7d

updating typo from dialogvlow_v2 to dialogflow_v2

parthea pushed a commit that referenced this issue Sep 22, 2023

chore(deps): update dependency google-cloud-bigquery-datatransfer to …

f961a2e

…v3.11.2 (#472)

parthea pushed a commit that referenced this issue Oct 21, 2023

chore(main): release 3.9.0 (#472)

55be036

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Version the docs #472

Version the docs #472

ptone commented Dec 29, 2014

dhermes commented Dec 29, 2014

silvolu commented Dec 30, 2014

yjkogan commented Jan 30, 2015

rstuart85 commented Feb 5, 2015

dhermes commented Feb 6, 2015

silvolu commented Feb 6, 2015

dhermes commented Feb 7, 2015

dhermes commented Feb 12, 2015

rstuart85 commented Feb 12, 2015

dhermes commented Feb 14, 2015

Version the docs #472

Version the docs #472

Comments

ptone commented Dec 29, 2014

dhermes commented Dec 29, 2014

silvolu commented Dec 30, 2014

yjkogan commented Jan 30, 2015

rstuart85 commented Feb 5, 2015

dhermes commented Feb 6, 2015

silvolu commented Feb 6, 2015

dhermes commented Feb 7, 2015

dhermes commented Feb 12, 2015

rstuart85 commented Feb 12, 2015

dhermes commented Feb 14, 2015