Skip to content

Commit 7ed8e66

Browse files
committed
migrate to autogenerated docs/index.rst with post processing
1 parent 824a177 commit 7ed8e66

File tree

2 files changed

+88
-19
lines changed

2 files changed

+88
-19
lines changed

packages/google-cloud-bigquery-storage/docs/index.rst

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,43 @@
22

33
.. include:: multiprocessing.rst
44

5-
This package includes clients for multiple versions of Google BigQuery Storage.
6-
By default, you will get version ``bigquery_storage_v1``.
75

8-
9-
API Reference
6+
Example Usage
107
-------------
11-
.. toctree::
12-
:maxdepth: 2
138

14-
bigquery_storage_v1/services_
15-
bigquery_storage_v1/types_
9+
.. literalinclude:: samples/quickstart/quickstart.py
10+
:language: python
11+
:dedent: 4
12+
:start-after: [START bigquerystorage_quickstart]
13+
:end-before: [END bigquerystorage_quickstart]
14+
1615

1716
API Reference
1817
-------------
1918
.. toctree::
2019
:maxdepth: 2
2120

21+
bigquery_storage_v1/library
22+
bigquery_storage_v1/services_
23+
bigquery_storage_v1/types_
24+
bigquery_storage_v1beta/services_
25+
bigquery_storage_v1beta/types_
26+
bigquery_storage_v1beta2/library
27+
bigquery_storage_v1beta2/services_
28+
bigquery_storage_v1beta2/types_
2229
bigquery_storage_v1alpha/services_
2330
bigquery_storage_v1alpha/types_
2431

25-
API Reference
26-
-------------
27-
.. toctree::
28-
:maxdepth: 2
2932

30-
bigquery_storage_v1beta/services_
31-
bigquery_storage_v1beta/types_
33+
Migration Guide
34+
---------------
35+
36+
See the guide below for instructions on migrating to the 2.x release of this library.
3237

33-
API Reference
34-
-------------
3538
.. toctree::
3639
:maxdepth: 2
3740

38-
bigquery_storage_v1beta2/services_
39-
bigquery_storage_v1beta2/types_
40-
41+
UPGRADING
4142

4243
Changelog
4344
---------

scripts/client-post-processing/bigquery-storage-integration.yaml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,3 +430,71 @@ replacements:
430430
"BigQueryWriteClient",
431431
)
432432
count: 1
433+
# Given that this file is mostly handwritten, we could omit the file completely when we migrate to librarian
434+
# See `preserve_regex` in https://github.com/googleapis/librarian/blob/main/doc/language-onboarding.md#generate
435+
# We could also consider updating the docs/index.rst template so that the majority of handwritten changes are not required
436+
- paths: [
437+
packages/google-cloud-bigquery-storage/docs/index.rst,
438+
]
439+
before: |
440+
.. include:: README.rst\n
441+
.. include:: multiprocessing.rst\n
442+
This package includes clients for multiple versions of Google BigQuery Storage.
443+
By default, you will get version ``bigquery_storage_v1``.\n\n
444+
API Reference
445+
-------------
446+
.. toctree::
447+
:maxdepth: 2\n
448+
bigquery_storage_v1/services_
449+
bigquery_storage_v1/types_\n
450+
API Reference
451+
-------------
452+
.. toctree::
453+
:maxdepth: 2\n
454+
bigquery_storage_v1alpha/services_
455+
bigquery_storage_v1alpha/types_\n
456+
API Reference
457+
-------------
458+
.. toctree::
459+
:maxdepth: 2\n
460+
bigquery_storage_v1beta/services_
461+
bigquery_storage_v1beta/types_\n
462+
API Reference
463+
-------------
464+
.. toctree::
465+
:maxdepth: 2\n
466+
bigquery_storage_v1beta2/services_
467+
bigquery_storage_v1beta2/types_\n\n
468+
Changelog
469+
after: |
470+
.. include:: README.rst\n
471+
.. include:: multiprocessing.rst\n\n
472+
Example Usage
473+
-------------\n
474+
.. literalinclude:: samples/quickstart/quickstart.py
475+
:language: python
476+
:dedent: 4
477+
:start-after: [START bigquerystorage_quickstart]
478+
:end-before: [END bigquerystorage_quickstart]\n\n
479+
API Reference
480+
-------------
481+
.. toctree::
482+
:maxdepth: 2\n
483+
bigquery_storage_v1/library
484+
bigquery_storage_v1/services_
485+
bigquery_storage_v1/types_
486+
bigquery_storage_v1beta/services_
487+
bigquery_storage_v1beta/types_
488+
bigquery_storage_v1beta2/library
489+
bigquery_storage_v1beta2/services_
490+
bigquery_storage_v1beta2/types_
491+
bigquery_storage_v1alpha/services_
492+
bigquery_storage_v1alpha/types_\n\n
493+
Migration Guide
494+
---------------\n
495+
See the guide below for instructions on migrating to the 2.x release of this library.\n
496+
.. toctree::
497+
:maxdepth: 2\n
498+
UPGRADING\n
499+
Changelog
500+
count: 1

0 commit comments

Comments
 (0)