Skip to content

Clean up docs after section captions added #1035

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.

Sign up for GitHub

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

Jump to bottom
Merged
dhermes merged 4 commits into from
Aug 5, 2015
Merged

Clean up docs after section captions added #1035

dhermes merged 4 commits into from
Aug 5, 2015

Conversation

@dhermes
Copy link
Contributor

@dhermes dhermes commented Aug 5, 2015

  • Renaming some .rst docs since captions now hold headings.
  • Removing the out-of-date, hard to find _components/*-quickstart.rst as well.
  • Folded documentation for connections in client documentation, since we don't really ever need to talk about a connection without a client.
  • Folding in getting started doc into main index.rst.
  • Removing unused Makefile and components.

Fixes #1034.

dhermes added 2 commits August 5, 2015 10:43
@dhermes
Renaming some .rst docs since captions now hold headings.
f560c65 
Removing the out-of-date, hard to find _components/*-quickstart.rst
as well.

Folded documentation for connections in client documentation,
since we don't really ever need to talk about a connection
without a client.
@dhermes
Folding in getting started doc into main index.rst.
54d28ec
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Aug 5, 2015
@dhermes dhermes added the docs label Aug 5, 2015
@dhermes dhermes mentioned this pull request Aug 5, 2015
Merged
dhermes
dhermes reviewed Aug 5, 2015
View reviewed changes
docs/bigquery-usage.rst

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

@dhermes
Copy link
Contributor Author

dhermes commented Aug 5, 2015

@tseaver Regarding all your "Ditto" comments about removed documents, none of those were published in any place.

We can follow this up with usage docs or on-ramps for each sub-package?

tseaver
tseaver reviewed Aug 5, 2015
View reviewed changes
docs/pubsub-client.rst Outdated

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

@tseaver
Copy link
Contributor

tseaver commented Aug 5, 2015

Re the _components fragments: if we don't need anything like them anywhere, then just dropping them is fine. FWIW, I have a feeling that trying to review docs as diffs is waaaay harder than reviewing software.

@dhermes
Copy link
Contributor Author

dhermes commented Aug 5, 2015

Maybe we should see how difficult it would be to use https://github.com/bslatkin/dpxdt for docs diffs?

@dhermes dhermes mentioned this pull request Aug 5, 2015
Closed
8 tasks
@tseaver
Copy link
Contributor

tseaver commented Aug 5, 2015

I'm less worried about how the changes look, and more about how hard it is to keep the overall context / usage paths straight in one's head, in order to make reasoned judgements about the changes.

@dhermes
Copy link
Contributor Author

dhermes commented Aug 5, 2015

@tseaver To confirm, these are the things to do:

  • Put Makefile back
  • Make page titles that are ambiguous also refer to the package they live in

@tseaver
Copy link
Contributor

tseaver commented Aug 5, 2015

@dhermes that sounds right to me.

dhermes added 2 commits August 5, 2015 14:20
@dhermes
Removing unused components.
bd8bcbc
@dhermes
Adding clarifying (by package) page titles where needed.
f9427af 
Stilling preserving the short name in the toctree.

Also adding trailing newlines to all .rst files that\
didn't have it (this was a side-effect of my editor,
but not a bad one).
@dhermes dhermes force-pushed the clean-up-docs-after-section-captions-added branch from 17676f9 to f9427af Compare August 5, 2015 21:32
@dhermes
Copy link
Contributor Author

dhermes commented Aug 5, 2015

@tseaver PTAL

@tseaver
Copy link
Contributor

tseaver commented Aug 5, 2015

LGTM

dhermes added a commit that referenced this pull request Aug 5, 2015
@dhermes
Merge pull request #1035 from dhermes/clean-up-docs-after-section-cap…
73f1a2d 
…tions-added

Clean up docs after section captions added
@dhermes dhermes merged commit 73f1a2d into googleapis:master Aug 5, 2015
@dhermes dhermes deleted the clean-up-docs-after-section-captions-added branch August 5, 2015 22:27
@dhermes dhermes mentioned this pull request Aug 12, 2015
Merged
parthea pushed a commit that referenced this pull request Nov 22, 2025
@daniel-sanche
chore: remove pooled transport (#1035)
f6a35be
parthea pushed a commit that referenced this pull request Nov 24, 2025
@gcf-owl-bot
build(deps): bump cryptography from 42.0.2 to 42.0.4 in .kokoro (#1035)
6fa4764 
Source-Link: googleapis/synthtool@d895aec
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:98f3afd11308259de6e828e37376d18867fd321aba07826e29e4f8d9cab56bad

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
parthea pushed a commit that referenced this pull request Nov 24, 2025
@gcf-owl-bot @daniel-sanche
chore: Update gapic-generator-python to 1.24.1 (#1035)
abc5ecc 
* feat: add the UserCreds API

PiperOrigin-RevId: 742708704

Source-Link: googleapis/googleapis@35980b6

Source-Link: googleapis/googleapis-gen@23742c6
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjM3NDJjNmRlZWNjODFkZTA1MjVkMmVlNzk4MGUyNThlNDNmZWU1YiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* feat: new Firestore index modes and Database Editions

PiperOrigin-RevId: 745570206

Source-Link: googleapis/googleapis@4ec607b

Source-Link: googleapis/googleapis-gen@49fab77
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDlmYWI3NzhiNzA5ODg3MGY5OTFlYmRlOTFkYTVmOTI2ZjQwNmZkNSJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* chore: Update gapic-generator-python to 1.24.0

PiperOrigin-RevId: 747419463

Source-Link: googleapis/googleapis@340579b

Source-Link: googleapis/googleapis-gen@e8997ec
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZTg5OTdlYzUxMzZlY2I2ZWQ5YTk2OWE0YzJmMTNiM2FiNmExN2MxMiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* chore: Update gapic-generator-python to 1.24.1

PiperOrigin-RevId: 748739072

Source-Link: googleapis/googleapis@b947e52

Source-Link: googleapis/googleapis-gen@8c5821a
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOGM1ODIxYWE2NWE5MjFkNTliM2Y3NjUzZDZmMzdjOWM2NzQxMGMyZiJ9

* 🦉 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: Daniel Sanche <[email protected]>
parthea pushed a commit that referenced this pull request Nov 26, 2025
@arithmetic1728
chore: update sys test creds (#1035)
939c958
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dhermes @tseaver @googlebot