Skip to content

Commit

Permalink
Update docs to use api_core instead of api.core (#4220)
Browse files Browse the repository at this point in the history
* Updating docs to use api_core instead of api.core

* Remove ALL_PACKAGES
  • Loading branch information
Jon Wayne Parrott authored Oct 18, 2017
1 parent b3197f0 commit 961c70c
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 37 deletions.
2 changes: 1 addition & 1 deletion docs/core/exceptions.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Exceptions
==========

.. automodule:: google.api.core.exceptions
.. automodule:: google.api_core.exceptions
:members:
:show-inheritance:
6 changes: 3 additions & 3 deletions docs/core/helpers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@ Helpers
General Helpers
---------------

.. automodule:: google.api.core.general_helpers
.. automodule:: google.api_core.general_helpers
:members:
:show-inheritance:


Datetime Helpers
----------------

.. automodule:: google.api.core.datetime_helpers
.. automodule:: google.api_core.datetime_helpers
:members:
:show-inheritance:


gRPC Helpers
------------

.. automodule:: google.api.core.grpc_helpers
.. automodule:: google.api_core.grpc_helpers
:members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/core/operation.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Long-Running Operations
=======================

.. automodule:: google.api.core.operation
.. automodule:: google.api_core.operation
:members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/core/operations_client.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Long-Running Operations Client
==============================

.. automodule:: google.api.core.operations_v1
.. automodule:: google.api_core.operations_v1
:members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/core/page_iterator.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Page Iterators
==============

.. automodule:: google.api.core.page_iterator
.. automodule:: google.api_core.page_iterator
:members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/core/path_template.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Path Templates
==============

.. automodule:: google.api.core.path_template
.. automodule:: google.api_core.path_template
:members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/core/retry.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Retry
=====

.. automodule:: google.api.core.retry
.. automodule:: google.api_core.retry
:members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/core/timeout.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Timeout
=======

.. automodule:: google.api.core.timeout
.. automodule:: google.api_core.timeout
:members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
setuptools >= 36.4.0
sphinx >= 1.6.3

api_core/
core/
storage/
bigquery/
Expand Down
28 changes: 1 addition & 27 deletions nox.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,6 @@
import nox


ALL_PACKAGES = (
'core/',
'storage/',
'bigquery/',
'bigtable/',
'datastore/',
'dns/',
'firestore/',
'language/',
'logging/',
# error_reporting is out of alphabetical order, it depends on logging.
'error_reporting/',
'monitoring/',
'pubsub/',
'resource_manager/',
'runtimeconfig/',
'spanner/',
'speech/',
'trace/',
'translate/',
'videointelligence/',
'vision/',
)


@nox.session
def docs(session):
"""Build the docs."""
Expand All @@ -54,8 +29,7 @@ def docs(session):

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

# Build the docs!
session.run(
Expand Down

0 comments on commit 961c70c

Please sign in to comment.