Skip to content

Commit

Permalink
Using the readthedocs theme.
Browse files Browse the repository at this point in the history
  • Loading branch information
dhermes committed Jul 25, 2015
1 parent 9d11ecc commit 396a105
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
7 changes: 7 additions & 0 deletions docs/cluster-standalone.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Cluster (Alternate Implementation)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: gcloud_bigtable.cluster_standalone
:members:
:undoc-members:
:show-inheritance:
6 changes: 5 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
import sys
import shlex

import sphinx_rtd_theme

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Expand Down Expand Up @@ -118,7 +120,9 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
if os.environ.get('READTHEDOCS', None) != 'True':
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ Documented Modules
cluster-connection
cluster
client
cluster-standalone

Indices and tables
~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion gcloud_bigtable/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ def list_clusters(self, timeout_seconds=TIMEOUT_SECONDS):
:rtype: tuple
:returns: A pair of results, the first is a list of
:class:`.cluster_standalone.Cluster`s returned and the second
:class:`.cluster_standalone.Cluster` s returned and the second
is a list of strings (the failed zones in the request).
"""
request_pb = messages_pb2.ListClustersRequest(name=self.project_name)
Expand Down

0 comments on commit 396a105

Please sign in to comment.