Add session docs to nox (via synth). (#7788)

websecurityscanner/docs/README.rst

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

websecurityscanner/docs/changelog.md

@@ -0,0 +1 @@
+../CHANGELOG.md

websecurityscanner/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-websecurityscanner-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 = {
@@ -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

websecurityscanner/docs/index.rst

@@ -1,4 +1,4 @@
-.. include:: /../websecurityscanner/README.rst
+.. include:: README.rst
 
 Api Reference
 -------------
@@ -7,3 +7,4 @@ Api Reference
 
     gapic/v1alpha/api
     gapic/v1alpha/types
+    changelog

websecurityscanner/google/cloud/websecurityscanner_v1alpha/gapic/web_security_scanner_client.py

@@ -83,6 +83,17 @@ def from_service_account_file(cls, filename, *args, **kwargs):
 
     from_service_account_json = from_service_account_file
 
+    @classmethod
+    def finding_path(cls, project, scan_config, scan_run, finding):
+        """Return a fully-qualified finding string."""
+        return google.api_core.path_template.expand(
+            "projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/findings/{finding}",
+            project=project,
+            scan_config=scan_config,
+            scan_run=scan_run,
+            finding=finding,
+        )
+
     @classmethod
     def project_path(cls, project):
         """Return a fully-qualified project string."""
@@ -109,17 +120,6 @@ def scan_run_path(cls, project, scan_config, scan_run):
             scan_run=scan_run,
         )
 
-    @classmethod
-    def finding_path(cls, project, scan_config, scan_run, finding):
-        """Return a fully-qualified finding string."""
-        return google.api_core.path_template.expand(
-            "projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/findings/{finding}",
-            project=project,
-            scan_config=scan_config,
-            scan_run=scan_run,
-            finding=finding,
-        )
-
     def __init__(
         self,
         transport=None,

websecurityscanner/noxfile.py

@@ -16,6 +16,7 @@
 
 from __future__ import absolute_import
 import os
+import shutil
 
 import nox
 
@@ -144,6 +145,7 @@ def docs(session):
     """Build the docs for this library."""
 
     session.install('sphinx', 'alabaster', 'recommonmark')
+    session.install('e', '.')
 
     shutil.rmtree(os.path.join('docs', '_build'), ignore_errors=True)
     session.run(

websecurityscanner/synth.metadata

@@ -1,19 +1,19 @@
 {
-  "updateTime": "2019-04-18T12:37:39.742265Z",
+  "updateTime": "2019-04-23T21:39:46.088381Z",
   "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": "d35ca3509160f09d3b0cc5360531751d95f3e292",
-        "internalRef": "244086609"
+        "sha": "45199a22a4e47c8d53213d1ac4a5ad7f22382c56",
+        "internalRef": "244925894"
       }
     },
     {

websecurityscanner/synth.py

@@ -34,6 +34,7 @@
 s.move(library / "google/cloud/websecurityscanner_v1alpha/proto")
 s.move(library / "google/cloud/websecurityscanner_v1alpha/gapic")
 s.move(library / "tests/unit/gapic/v1alpha")
+s.move(library / "docs/conf.py")
 
 # ----------------------------------------------------------------------------
 # Add templated files