-
Notifications
You must be signed in to change notification settings - Fork 69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Bullet lists in docstrings should end with blank lines #604
Comments
I am also encountering this in the Spanner library:
becomes
|
Happened here, too: googleapis/python-bigquery-reservation#47 Source protos do not include "This corresponds to ...", so this is probably caused by the templates in the generator. |
Maybe as simple as removing the Line 293 in 09692c4
Line 141 in 09692c4
gapic-generator-python/gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2 Line 304 in 09692c4
|
Cross-references like `~.ImageAnnotatorClient` don't always work correctly with sphinx. This PR changes the `sphinx()` method to always produce a full path like `google.cloud.vision_v1.ImageAnnotatorClient`. Also some other smaller changes: - Generate a separate `.rst` page for each service, which improves readability for APIs that have (1) a lot of services or (2) a lot of methods in a service. `services.rst` acts as an index page instead. - Add pagers to the generated docs - Use `undoc-members` to list enum attributes in generated docs (fixes #625) - Add newlines after bulleted lists by removing `nl=False`. Fixes #604 - Add a 'docs' session to the templated `noxfile.py` so folks using the self-service model can have generated docs. - Fix reference to LRO result type in `Returns:` - Fix `{@api.name}` reference in the `from_service_account..`. methods to reference the client type instead - Remove `:class:` notation when specifying types for attributes (sphinx doesn't need it to create a link)
🤖 I have created a release \*beep\* \*boop\* --- ## [0.39.0](https://www.github.com/googleapis/gapic-generator-python/compare/v0.38.0...v0.39.0) (2020-12-22) ### Features * allow warehouse name to be customized ([#717](https://www.github.com/googleapis/gapic-generator-python/issues/717)) ([7c185e8](https://www.github.com/googleapis/gapic-generator-python/commit/7c185e87cb4252b1f99ed121515814595f9492c4)), closes [#605](https://www.github.com/googleapis/gapic-generator-python/issues/605) ### Bug Fixes * fix sphinx identifiers ([#714](https://www.github.com/googleapis/gapic-generator-python/issues/714)) ([39be474](https://www.github.com/googleapis/gapic-generator-python/commit/39be474b4419dfa521ef51927fd36dbf257d68e3)), closes [#625](https://www.github.com/googleapis/gapic-generator-python/issues/625) [#604](https://www.github.com/googleapis/gapic-generator-python/issues/604) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please).
Gets turned into
Which results in a Sphinx warning
The text was updated successfully, but these errors were encountered: