Add nox session docs, add routing header to method metadata, reorde…

…r methods (via synth).. (#7771)

firestore/docs/README.rst

@@ -0,0 +1 @@
+../README.rst

firestore/docs/conf.py

@@ -25,7 +25,7 @@
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-# needs_sphinx = '1.0'
+needs_sphinx = "1.6.3"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -36,6 +36,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.coverage",
     "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
     "sphinx.ext.viewcode",
 ]
 
@@ -47,10 +48,14 @@
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
+# Allow markdown includes (so releases.md can include CHANGLEOG.md)
+# http://www.sphinx-doc.org/en/master/markdown.html
+source_parsers = {".md": "recommonmark.parser.CommonMarkParser"}
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']
-source_suffix = ".rst"
+source_suffix = [".rst", ".md"]
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
@@ -120,12 +125,20 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "sphinx_rtd_theme"
+html_theme = "alabaster"
 
 # 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
 # documentation.
-# html_theme_options = {}
+html_theme_options = {
+    "description": "Google Cloud Client Libraries for Python",
+    "github_user": "googleapis",
+    "github_repo": "google-cloud-python",
+    "github_banner": True,
+    "font_family": "'Roboto', Georgia, sans",
+    "head_font_family": "'Roboto', Georgia, serif",
+    "code_font_family": "'Roboto Mono', 'Consolas', monospace",
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -214,6 +227,17 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = "google-cloud-firestore-doc"
 
+# -- Options for warnings ------------------------------------------------------
+
+suppress_warnings = [
+    # Temporarily suppress this to avoid "more than one target found for
+    # cross-reference" warning, which are intractable for us to avoid while in
+    # a mono-repo.
+    # See https://github.com/sphinx-doc/sphinx/blob
+    # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843
+    "ref.python"
+]
+
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
@@ -289,7 +313,7 @@
         u"google-cloud-firestore Documentation",
         author,
         "google-cloud-firestore",
-        "GAPIC library for the {metadata.shortName} v1beta1 service",
+        "GAPIC library for the {metadata.shortName}",
         "APIs",
     )
 ]
@@ -310,6 +334,16 @@
 intersphinx_mapping = {
     "python": ("http://python.readthedocs.org/en/latest/", None),
     "gax": ("https://gax-python.readthedocs.org/en/latest/", None),
+    "google-auth": ("https://google-auth.readthedocs.io/en/stable", None),
+    "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None),
+    "google.api_core": (
+        "https://googleapis.github.io/google-cloud-python/latest",
+        None,
+    ),
+    "grpc": ("https://grpc.io/grpc/python/", None),
+    "requests": ("http://docs.python-requests.org/en/master/", None),
+    "fastavro": ("https://fastavro.readthedocs.io/en/stable/", None),
+    "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
 }
 
 # Napoleon settings

firestore/docs/index.rst

@@ -1,4 +1,4 @@
-.. include:: /../firestore/README.rst
+.. include:: README.rst
 
 
 API Reference

firestore/google/cloud/firestore_v1/gapic/firestore_client.py

@@ -96,19 +96,21 @@ def from_service_account_file(cls, filename, *args, **kwargs):
     from_service_account_json = from_service_account_file
 
     @classmethod
-    def database_root_path(cls, project, database):
-        """Return a fully-qualified database_root string."""
+    def any_path_path(cls, project, database, document, any_path):
+        """Return a fully-qualified any_path string."""
         return google.api_core.path_template.expand(
-            "projects/{project}/databases/{database}",
+            "projects/{project}/databases/{database}/documents/{document}/{any_path=**}",
             project=project,
             database=database,
+            document=document,
+            any_path=any_path,
         )
 
     @classmethod
-    def document_root_path(cls, project, database):
-        """Return a fully-qualified document_root string."""
+    def database_root_path(cls, project, database):
+        """Return a fully-qualified database_root string."""
         return google.api_core.path_template.expand(
-            "projects/{project}/databases/{database}/documents",
+            "projects/{project}/databases/{database}",
             project=project,
             database=database,
         )
@@ -124,14 +126,12 @@ def document_path_path(cls, project, database, document_path):
         )
 
     @classmethod
-    def any_path_path(cls, project, database, document, any_path):
-        """Return a fully-qualified any_path string."""
+    def document_root_path(cls, project, database):
+        """Return a fully-qualified document_root string."""
         return google.api_core.path_template.expand(
-            "projects/{project}/databases/{database}/documents/{document}/{any_path=**}",
+            "projects/{project}/databases/{database}/documents",
             project=project,
             database=database,
-            document=document,
-            any_path=any_path,
         )
 
     def __init__(

firestore/google/cloud/firestore_v1beta1/gapic/firestore_client.py

@@ -96,19 +96,21 @@ def from_service_account_file(cls, filename, *args, **kwargs):
     from_service_account_json = from_service_account_file
 
     @classmethod
-    def database_root_path(cls, project, database):
-        """Return a fully-qualified database_root string."""
+    def any_path_path(cls, project, database, document, any_path):
+        """Return a fully-qualified any_path string."""
         return google.api_core.path_template.expand(
-            "projects/{project}/databases/{database}",
+            "projects/{project}/databases/{database}/documents/{document}/{any_path=**}",
             project=project,
             database=database,
+            document=document,
+            any_path=any_path,
         )
 
     @classmethod
-    def document_root_path(cls, project, database):
-        """Return a fully-qualified document_root string."""
+    def database_root_path(cls, project, database):
+        """Return a fully-qualified database_root string."""
         return google.api_core.path_template.expand(
-            "projects/{project}/databases/{database}/documents",
+            "projects/{project}/databases/{database}",
             project=project,
             database=database,
         )
@@ -124,14 +126,12 @@ def document_path_path(cls, project, database, document_path):
         )
 
     @classmethod
-    def any_path_path(cls, project, database, document, any_path):
-        """Return a fully-qualified any_path string."""
+    def document_root_path(cls, project, database):
+        """Return a fully-qualified document_root string."""
         return google.api_core.path_template.expand(
-            "projects/{project}/databases/{database}/documents/{document}/{any_path=**}",
+            "projects/{project}/databases/{database}/documents",
             project=project,
             database=database,
-            document=document,
-            any_path=any_path,
         )
 
     def __init__(

firestore/noxfile.py

@@ -16,6 +16,7 @@
 
 from __future__ import absolute_import
 import os
+import shutil
 
 import nox
 
@@ -138,3 +139,22 @@ def cover(session):
     session.run("coverage", "report", "--show-missing", "--fail-under=100")
 
     session.run("coverage", "erase")
+
+@nox.session(python="3.7")
+def docs(session):
+    """Build the docs for this library."""
+
+    session.install('-e', '.')
+    session.install('sphinx', 'alabaster', 'recommonmark')
+
+    shutil.rmtree(os.path.join('docs', '_build'), ignore_errors=True)
+    session.run(
+        'sphinx-build',
+        '-W',  # warnings as errors
+        '-T',  # show full traceback on exception
+        '-N',  # no colors
+        '-b', 'html',
+        '-d', os.path.join('docs', '_build', 'doctrees', ''),
+        os.path.join('docs', ''),
+        os.path.join('docs', '_build', 'html', ''),
+    )

firestore/synth.metadata

@@ -1,19 +1,19 @@
 {
-  "updateTime": "2019-04-18T19:15:20.848201Z",
+  "updateTime": "2019-04-23T12:17:45.098370Z",
   "sources": [
     {
       "generator": {
         "name": "artman",
-        "version": "0.16.25",
-        "dockerImage": "googleapis/artman@sha256:d9597f983d1d4e61272c63cb97b7d8f8234da9999526c35d357de3d781f0ec1b"
+        "version": "0.17.0",
+        "dockerImage": "googleapis/artman@sha256:c58f4ec3838eb4e0718eb1bccc6512bd6850feaa85a360a9e38f6f848ec73bc2"
       }
     },
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "9a89b9443aa9d43ccecbd5200cb866e551bbd5e7",
-        "internalRef": "244215550"
+        "sha": "547e19e7df398e9290e8e3674d7351efc500f9b0",
+        "internalRef": "244712781"
       }
     },
     {