Skip to content

Commit 961c70c

Browse files
author
Jon Wayne Parrott
authored
Update docs to use api_core instead of api.core (googleapis#4220)
* Updating docs to use api_core instead of api.core * Remove ALL_PACKAGES
1 parent b3197f0 commit 961c70c

10 files changed

Lines changed: 12 additions & 37 deletions

docs/core/exceptions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Exceptions
22
==========
33

4-
.. automodule:: google.api.core.exceptions
4+
.. automodule:: google.api_core.exceptions
55
:members:
66
:show-inheritance:

docs/core/helpers.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@ Helpers
55
General Helpers
66
---------------
77

8-
.. automodule:: google.api.core.general_helpers
8+
.. automodule:: google.api_core.general_helpers
99
:members:
1010
:show-inheritance:
1111

1212

1313
Datetime Helpers
1414
----------------
1515

16-
.. automodule:: google.api.core.datetime_helpers
16+
.. automodule:: google.api_core.datetime_helpers
1717
:members:
1818
:show-inheritance:
1919

2020

2121
gRPC Helpers
2222
------------
2323

24-
.. automodule:: google.api.core.grpc_helpers
24+
.. automodule:: google.api_core.grpc_helpers
2525
:members:
2626
:show-inheritance:

docs/core/operation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Long-Running Operations
22
=======================
33

4-
.. automodule:: google.api.core.operation
4+
.. automodule:: google.api_core.operation
55
:members:
66
:show-inheritance:

docs/core/operations_client.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Long-Running Operations Client
22
==============================
33

4-
.. automodule:: google.api.core.operations_v1
4+
.. automodule:: google.api_core.operations_v1
55
:members:
66
:show-inheritance:

docs/core/page_iterator.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Page Iterators
22
==============
33

4-
.. automodule:: google.api.core.page_iterator
4+
.. automodule:: google.api_core.page_iterator
55
:members:
66
:show-inheritance:

docs/core/path_template.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Path Templates
22
==============
33

4-
.. automodule:: google.api.core.path_template
4+
.. automodule:: google.api_core.path_template
55
:members:
66
:show-inheritance:

docs/core/retry.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Retry
22
=====
33

4-
.. automodule:: google.api.core.retry
4+
.. automodule:: google.api_core.retry
55
:members:
66
:show-inheritance:

docs/core/timeout.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Timeout
22
=======
33

4-
.. automodule:: google.api.core.timeout
4+
.. automodule:: google.api_core.timeout
55
:members:
66
:show-inheritance:

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
setuptools >= 36.4.0
22
sphinx >= 1.6.3
33

4+
api_core/
45
core/
56
storage/
67
bigquery/

nox.py

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,31 +17,6 @@
1717
import nox
1818

1919

20-
ALL_PACKAGES = (
21-
'core/',
22-
'storage/',
23-
'bigquery/',
24-
'bigtable/',
25-
'datastore/',
26-
'dns/',
27-
'firestore/',
28-
'language/',
29-
'logging/',
30-
# error_reporting is out of alphabetical order, it depends on logging.
31-
'error_reporting/',
32-
'monitoring/',
33-
'pubsub/',
34-
'resource_manager/',
35-
'runtimeconfig/',
36-
'spanner/',
37-
'speech/',
38-
'trace/',
39-
'translate/',
40-
'videointelligence/',
41-
'vision/',
42-
)
43-
44-
4520
@nox.session
4621
def docs(session):
4722
"""Build the docs."""
@@ -54,8 +29,7 @@ def docs(session):
5429

5530
# Install Sphinx and also all of the google-cloud-* packages.
5631
session.chdir(os.path.realpath(os.path.dirname(__file__)))
57-
session.install('Sphinx >= 1.6.3', 'sphinx_rtd_theme')
58-
session.install(*ALL_PACKAGES)
32+
session.install('-r', os.path.join('docs', 'requirements.txt'))
5933

6034
# Build the docs!
6135
session.run(

0 commit comments

Comments
 (0)