Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

docs: document enum values with undoc-members option #93

Merged
merged 3 commits into from Jan 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 2 additions & 20 deletions .coveragerc
@@ -1,34 +1,16 @@
# -*- coding: utf-8 -*-
#
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Generated by synthtool. DO NOT EDIT!
[run]
branch = True

[report]
fail_under = 100
show_missing = True
omit = google/cloud/datacatalog/__init__.py
omit =
google/cloud/datacatalog/__init__.py
exclude_lines =
# Re-enable the standard pragma
pragma: NO COVER
# Ignore debug-only repr
def __repr__
# Ignore abstract methods
raise NotImplementedError
# Ignore pkg_resources exceptions.
# This is added at the module level as a safeguard for if someone
# generates the code and tries to run it without pip installing. This
Expand Down
11 changes: 11 additions & 0 deletions docs/datacatalog_v1/data_catalog.rst
@@ -0,0 +1,11 @@
DataCatalog
-----------------------------

.. automodule:: google.cloud.datacatalog_v1.services.data_catalog
:members:
:inherited-members:


.. automodule:: google.cloud.datacatalog_v1.services.data_catalog.pagers
:members:
:inherited-members:
6 changes: 3 additions & 3 deletions docs/datacatalog_v1/services.rst
@@ -1,6 +1,6 @@
Services for Google Cloud Datacatalog v1 API
============================================
.. toctree::
:maxdepth: 2

.. automodule:: google.cloud.datacatalog_v1.services.data_catalog
:members:
:inherited-members:
data_catalog
1 change: 1 addition & 0 deletions docs/datacatalog_v1/types.rst
Expand Up @@ -3,4 +3,5 @@ Types for Google Cloud Datacatalog v1 API

.. automodule:: google.cloud.datacatalog_v1.types
:members:
:undoc-members:
:show-inheritance:
11 changes: 11 additions & 0 deletions docs/datacatalog_v1beta1/data_catalog.rst
@@ -0,0 +1,11 @@
DataCatalog
-----------------------------

.. automodule:: google.cloud.datacatalog_v1beta1.services.data_catalog
:members:
:inherited-members:


.. automodule:: google.cloud.datacatalog_v1beta1.services.data_catalog.pagers
:members:
:inherited-members:
11 changes: 11 additions & 0 deletions docs/datacatalog_v1beta1/policy_tag_manager.rst
@@ -0,0 +1,11 @@
PolicyTagManager
----------------------------------

.. automodule:: google.cloud.datacatalog_v1beta1.services.policy_tag_manager
:members:
:inherited-members:


.. automodule:: google.cloud.datacatalog_v1beta1.services.policy_tag_manager.pagers
:members:
:inherited-members:
6 changes: 6 additions & 0 deletions docs/datacatalog_v1beta1/policy_tag_manager_serialization.rst
@@ -0,0 +1,6 @@
PolicyTagManagerSerialization
-----------------------------------------------

.. automodule:: google.cloud.datacatalog_v1beta1.services.policy_tag_manager_serialization
:members:
:inherited-members:
14 changes: 5 additions & 9 deletions docs/datacatalog_v1beta1/services.rst
@@ -1,12 +1,8 @@
Services for Google Cloud Datacatalog v1beta1 API
=================================================
.. toctree::
:maxdepth: 2

.. automodule:: google.cloud.datacatalog_v1beta1.services.data_catalog
:members:
:inherited-members:
.. automodule:: google.cloud.datacatalog_v1beta1.services.policy_tag_manager
:members:
:inherited-members:
.. automodule:: google.cloud.datacatalog_v1beta1.services.policy_tag_manager_serialization
:members:
:inherited-members:
data_catalog
policy_tag_manager
policy_tag_manager_serialization
1 change: 1 addition & 0 deletions docs/datacatalog_v1beta1/types.rst
Expand Up @@ -3,4 +3,5 @@ Types for Google Cloud Datacatalog v1beta1 API

.. automodule:: google.cloud.datacatalog_v1beta1.types
:members:
:undoc-members:
:show-inheritance: