docs(bigquery): fix the broken docs (#139)

* docs(bigquery): fix the broken docs * docs(bigquery): add autodoc_default_options into conf.py file
googleapis · Jun 19, 2020 · 3235255 · 3235255
1 parent de9998f
commit 3235255
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -43,7 +43,7 @@
 
 # autodoc/autosummary flags
 autoclass_content = "both"
-autodoc_default_flags = ["members", "inherited-members"]
+autodoc_default_options = {"members": True, "inherited-members": True}
 autosummary_generate = True
 
 

diff --git a/google/cloud/bigquery/dataset.py b/google/cloud/bigquery/dataset.py
@@ -84,7 +84,7 @@ class AccessEntry(object):
 
     See https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets.
 
-    Attributes:
+    Args:
         role (str):
             Role granted to the entity. The following string values are
             supported: `'READER'`, `'WRITER'`, `'OWNER'`. It may also be

diff --git a/synth.py b/synth.py
@@ -61,4 +61,10 @@
 templated_files = common.py_library(cov_level=100)
 s.move(templated_files, excludes=["noxfile.py"])
 
+s.replace(
+    "docs/conf.py",
+    r'\{"members": True\}',
+    '{"members": True, "inherited-members": True}'
+)
+
 s.shell.run(["nox", "-s", "blacken"], hide_output=False)