Repository navigation
Python documentation missing examples, etc #2037
Description
It seems to have disappeared:
https://googlecloudplatform.github.io/gcloud-python/#/docs/master/gcloud/datastore/client/client
{{ message }}
It seems to have disappeared:
https://googlecloudplatform.github.io/gcloud-python/#/docs/master/gcloud/datastore/client/client
Activity
dhermes commentedon Jul 30, 2016
@danielecook How do you mean disappeared? They are different from the previous Sphinx docs, but the Sphinx docs are still up at http://gcloud-python.readthedocs.io/en/latest/
Maybe @daspecster can comment about the differences?
danielecook commentedon Jul 30, 2016
Look at the content on that link I provided. There are no examples. There are no descriptions. This was not the case previously. Compare with the ruby language page. When I google 'gcloud-python' the first result is the link above - not the sphinx docs you provided. Why does documentation exist in multiple places? Thanks!
jgeewax commentedon Jul 30, 2016
@daspecster : I thought that we fixed this so the examples were still there... If not, can we... fix it?
[-]Python documentation missing[/-][+]Python documentation missing examples, etc[/+]daspecster commentedon Jul 30, 2016
Hey! So we're not pulling in the RST files and we have some examples in those.
I will have to check it out, but either we need to parse those usage RST files and find a place to put them in the doc site or we should move those over into the appropriate module doc strings. I think the latter would be the quickest.
The tricky part is going to be figuring out where to put things in the new doc site since I don't think there is really a good spot for those?
daspecster commentedon Jul 30, 2016
Actually I take that back,
The corresponding example mentioned above would be here http://gcloud-python.readthedocs.io/en/latest/datastore-client.html which has some example code in it. So this could really be a bug, I'll check it out. If the examples are literalincludes then yeah I don't have that built into the generator.
danielecook commentedon Aug 1, 2016
Thanks!
jgeewax commentedon Aug 1, 2016
OK -- so long as we get snippets back. That is an absolute requirement here....
tswast commentedon Aug 9, 2016
From the bug #2072 I closed as a duplicate of this one:
Compare http://googlecloudplatform.github.io/gcloud-python/0.17.0/bigquery-client.html and http://googlecloudplatform.github.io/gcloud-python/#/docs/master/gcloud/bigquery/client/client
There is a ton of information missing now. For example, I don't see any information about what parameters the constructor takes.
Also, the links to the "Using the API" pages have completely disappeared.
daspecster commentedon Aug 15, 2016
Sorry, I just got back in the US where the internet works most of the time haha.
@tswast thanks for the link, I'll see about the params as well.
Fix typo in legacy docs (#2037)
test: add unit test for remap_variables (#2037)