Skip to content

Fix datastore __init__ docstring.#2005

Merged
daspecster merged 1 commit into
googleapis:masterfrom
daspecster:fix-datastore-init-doc
Jul 20, 2016
Merged

Fix datastore __init__ docstring.#2005
daspecster merged 1 commit into
googleapis:masterfrom
daspecster:fix-datastore-init-doc

Conversation

@daspecster

Copy link
Copy Markdown
Contributor

This fixes the issue with datastore index doc not rendering the examples.

screen shot 2016-07-20 at 12 02 25 am

http://daspecster.github.io/gcloud-python/#/docs/master/gcloud/datastore

@dhermes, one small step closer but far far from perfect. I need to detect lists so that renders better.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jul 20, 2016
@dhermes

dhermes commented Jul 20, 2016

Copy link
Copy Markdown
Contributor

LGTM. Looks like that would've failed Sphinx rendering right?

@daspecster

Copy link
Copy Markdown
Contributor Author

Right, it would have but sphinx doesn't pull in the __init__.py's unless you force it too I think.
I think you need to add __all__ to the __init__.py to get it to work?

http://stackoverflow.com/a/30866624/89702

@daspecster daspecster merged commit b213cb8 into googleapis:master Jul 20, 2016
@daspecster daspecster deleted the fix-datastore-init-doc branch July 20, 2016 04:18
@dhermes

dhermes commented Jul 20, 2016

Copy link
Copy Markdown
Contributor

@daspecster We just never reference the base subpackage:

$ git grep automodule | grep gcloud | grep datastore
docs/datastore-batches.rst:.. automodule:: gcloud.datastore.batch
docs/datastore-client.rst:.. automodule:: gcloud.datastore.client
docs/datastore-client.rst:.. automodule:: gcloud.datastore.connection
docs/datastore-entities.rst:.. automodule:: gcloud.datastore.entity
docs/datastore-helpers.rst:.. automodule:: gcloud.datastore.helpers
docs/datastore-keys.rst:.. automodule:: gcloud.datastore.key
docs/datastore-queries.rst:.. automodule:: gcloud.datastore.query
docs/datastore-transactions.rst:.. automodule:: gcloud.datastore.transaction

and we even have a docs verifier which intentionally ignores that module

$ git grep 'gcloud.\datastore\.__init__'
scripts/verify_included_modules.py:    'gcloud.datastore.__init__',

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

Labels

cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants