Trace: Add nox session docs (via synth). (googleapis#7784)

yoshi-automation · busunkim96 · commit bebcb445697b · 2019-04-30T14:15:53.000-07:00
diff --git a/trace/docs/README.rst b/trace/docs/README.rst
@@ -0,0 +1 @@
+../README.rst
diff --git a/trace/docs/conf.py b/trace/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-trace-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 = {
@@ -304,6 +328,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
diff --git a/trace/docs/index.rst b/trace/docs/index.rst
@@ -1,4 +1,4 @@
-.. include:: /../trace/README.rst
+.. include:: README.rst
 
 
 API Reference
diff --git a/trace/noxfile.py b/trace/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', ''),
+    )
diff --git a/trace/synth.metadata b/trace/synth.metadata
@@ -1,26 +1,26 @@
 {
-  "updateTime": "2019-04-10T12:25:42.578391Z",
+  "updateTime": "2019-04-30T20:28:34.534273Z",
   "sources": [
     {
       "generator": {
         "name": "artman",
-        "version": "0.16.25",
-        "dockerImage": "googleapis/artman@sha256:d9597f983d1d4e61272c63cb97b7d8f8234da9999526c35d357de3d781f0ec1b"
+        "version": "0.17.1",
+        "dockerImage": "googleapis/artman@sha256:a40ca4dd4ef031c0ded4df4909ffdf7b3f20d29b23e682ef991eb60ba0ca6025"
       }
     },
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "3f57de2fbe951640b587d9c2d503daf554747749",
-        "internalRef": "242707837"
+        "sha": "be3005c8a16e8424d0330e977ac78f2976bf01d3",
+        "internalRef": "245840921"
       }
     },
     {
       "template": {
         "name": "python_library",
         "origin": "synthtool.gcp",
-        "version": "2019.2.26"
+        "version": "2019.4.24"
       }
     }
   ],
diff --git a/trace/synth.py b/trace/synth.py
@@ -42,6 +42,9 @@
         f"from google.cloud.trace_{version}.proto import ",
     )
 
+# Copy docs configuration
+s.move(library / f"docs/conf.py")
+
 # Issues exist where python files should define the source encoding
 # https://github.com/googleapis/gapic-generator/issues/2097
 s.replace("google/**/proto/*_pb2.py", r"(^.*$\n)*", r"# -*- coding: utf-8 -*-\n\g<0>")

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-.. include:: /../trace/README.rst`
	`1`	`+.. include:: README.rst`
`2`	`2`
`3`	`3`
`4`	`4`	`API Reference`
Original file line number	Diff line number	Diff line change
`@@ -1,26 +1,26 @@`
`1`	`1`	`{`
`2`		`- "updateTime": "2019-04-10T12:25:42.578391Z",`
	`2`	`+ "updateTime": "2019-04-30T20:28:34.534273Z",`
`3`	`3`	`"sources": [`
`4`	`4`	`{`
`5`	`5`	`"generator": {`
`6`	`6`	`"name": "artman",`
`7`		`- "version": "0.16.25",`
`8`		`- "dockerImage": "googleapis/artman@sha256:d9597f983d1d4e61272c63cb97b7d8f8234da9999526c35d357de3d781f0ec1b"`
	`7`	`+ "version": "0.17.1",`
	`8`	`+ "dockerImage": "googleapis/artman@sha256:a40ca4dd4ef031c0ded4df4909ffdf7b3f20d29b23e682ef991eb60ba0ca6025"`
`9`	`9`	`}`
`10`	`10`	`},`
`11`	`11`	`{`
`12`	`12`	`"git": {`
`13`	`13`	`"name": "googleapis",`
`14`	`14`	`"remote": "https://github.com/googleapis/googleapis.git",`
`15`		`- "sha": "3f57de2fbe951640b587d9c2d503daf554747749",`
`16`		`- "internalRef": "242707837"`
	`15`	`+ "sha": "be3005c8a16e8424d0330e977ac78f2976bf01d3",`
	`16`	`+ "internalRef": "245840921"`
`17`	`17`	`}`
`18`	`18`	`},`
`19`	`19`	`{`
`20`	`20`	`"template": {`
`21`	`21`	`"name": "python_library",`
`22`	`22`	`"origin": "synthtool.gcp",`
`23`		`- "version": "2019.2.26"`
	`23`	`+ "version": "2019.4.24"`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`	`],`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,9 @@`
`42`	`42`	`f"from google.cloud.trace_{version}.proto import ",`
`43`	`43`	`)`
`44`	`44`
	`45`	`+# Copy docs configuration`
	`46`	`+s.move(library / f"docs/conf.py")`
	`47`	`+`
`45`	`48`	`# Issues exist where python files should define the source encoding`
`46`	`49`	`# https://github.com/googleapis/gapic-generator/issues/2097`
`47`	`50`	`s.replace("google/*/proto/_pb2.py", r"(^.$\n)", r"# -- coding: utf-8 --\n\g<0>")`