From 0b7eef1267dd60ab2e924b24bb9a83c56fb93ab2 Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Wed, 9 Jun 2021 14:45:32 +0000 Subject: [PATCH 1/2] docs: use google-cloud-recaptcha-enterprise --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .repo-metadata.json | 2 +- CONTRIBUTING.rst | 2 +- docs/conf.py | 25 ++++++++++++------------- docs/multiprocessing.rst | 4 ++-- noxfile.py | 6 ++---- 6 files changed, 19 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 1b46d4f..0e5bf8b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -20,7 +20,7 @@ If you are still having issues, please be sure to include as much information as - OS type and version: - Python version: `python --version` - pip version: `pip --version` - - `google-cloud-recaptchaenterprise` version: `pip show google-cloud-recaptchaenterprise` + - `google-cloud-recaptcha-enterprise` version: `pip show google-cloud-recaptcha-enterprise` #### Steps to reproduce diff --git a/.repo-metadata.json b/.repo-metadata.json index 4c25213..e17dbcb 100644 --- a/.repo-metadata.json +++ b/.repo-metadata.json @@ -8,6 +8,6 @@ "language": "python", "library_type": "GAPIC_AUTO", "repo": "googleapis/python-recaptcha-enterprise", - "distribution_name": "google-cloud-recaptchaenterprise", + "distribution_name": "google-cloud-recaptcha-enterprise", "api_id": "recaptchaenterprise.googleapis.com" } diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 507ed3d..ef5abe7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -193,7 +193,7 @@ instead of ``https://github.com/googleapis/python-recaptcha-enterprise/blob/master/CONTRIBUTING.rst``) may cause problems creating links or rendering the description. -.. _description on PyPI: https://pypi.org/project/google-cloud-recaptchaenterprise +.. _description on PyPI: https://pypi.org/project/google-cloud-recaptcha-enterprise ************************* diff --git a/docs/conf.py b/docs/conf.py index 121ce1b..fdd7a26 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,7 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -# google-cloud-recaptchaenterprise documentation build configuration file +# google-cloud-recaptcha-enterprise documentation build configuration file # # This file is execfile()d with the current directory set to its # containing dir. @@ -80,7 +80,7 @@ master_doc = "index" # General information about the project. -project = u"google-cloud-recaptchaenterprise" +project = u"google-cloud-recaptcha-enterprise" copyright = u"2019, Google" author = u"Google APIs" @@ -153,7 +153,7 @@ # further. For a list of options available for each theme, see the # documentation. html_theme_options = { - "description": "Google Cloud Client Libraries for google-cloud-recaptchaenterprise", + "description": "Google Cloud Client Libraries for google-cloud-recaptcha-enterprise", "github_user": "googleapis", "github_repo": "python-recaptcha-enterprise", "github_banner": True, @@ -247,7 +247,7 @@ # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = "google-cloud-recaptchaenterprise-doc" +htmlhelp_basename = "google-cloud-recaptcha-enterprise-doc" # -- Options for warnings ------------------------------------------------------ @@ -280,8 +280,8 @@ latex_documents = [ ( master_doc, - "google-cloud-recaptchaenterprise.tex", - u"google-cloud-recaptchaenterprise Documentation", + "google-cloud-recaptcha-enterprise.tex", + u"google-cloud-recaptcha-enterprise Documentation", author, "manual", ) @@ -315,8 +315,8 @@ man_pages = [ ( master_doc, - "google-cloud-recaptchaenterprise", - u"google-cloud-recaptchaenterprise Documentation", + "google-cloud-recaptcha-enterprise", + u"google-cloud-recaptcha-enterprise Documentation", [author], 1, ) @@ -334,11 +334,11 @@ texinfo_documents = [ ( master_doc, - "google-cloud-recaptchaenterprise", - u"google-cloud-recaptchaenterprise Documentation", + "google-cloud-recaptcha-enterprise", + u"google-cloud-recaptcha-enterprise Documentation", author, - "google-cloud-recaptchaenterprise", - "google-cloud-recaptchaenterprise Library", + "google-cloud-recaptcha-enterprise", + "google-cloud-recaptcha-enterprise Library", "APIs", ) ] @@ -363,7 +363,6 @@ "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None,), "grpc": ("https://grpc.github.io/grpc/python/", None), "proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None), - "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), } diff --git a/docs/multiprocessing.rst b/docs/multiprocessing.rst index 536d17b..1cb29d4 100644 --- a/docs/multiprocessing.rst +++ b/docs/multiprocessing.rst @@ -1,7 +1,7 @@ .. note:: - Because this client uses :mod:`grpc` library, it is safe to + Because this client uses :mod:`grpcio` library, it is safe to share instances across threads. In multiprocessing scenarios, the best practice is to create client instances *after* the invocation of - :func:`os.fork` by :class:`multiprocessing.pool.Pool` or + :func:`os.fork` by :class:`multiprocessing.Pool` or :class:`multiprocessing.Process`. diff --git a/noxfile.py b/noxfile.py index 03aa2f5..70417e8 100644 --- a/noxfile.py +++ b/noxfile.py @@ -179,7 +179,7 @@ def docs(session): """Build the docs for this library.""" session.install("-e", ".") - session.install("sphinx==4.0.1", "alabaster", "recommonmark") + session.install("sphinx", "alabaster", "recommonmark") shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) session.run( @@ -201,9 +201,7 @@ def docfx(session): """Build the docfx yaml files for this library.""" session.install("-e", ".") - session.install( - "sphinx==4.0.1", "alabaster", "recommonmark", "gcp-sphinx-docfx-yaml" - ) + session.install("sphinx", "alabaster", "recommonmark", "gcp-sphinx-docfx-yaml") shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) session.run( From a259013e1598ff313eebae22a24e8d9835e1aa8b Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Wed, 9 Jun 2021 14:49:29 +0000 Subject: [PATCH 2/2] chore: undo changes --- docs/conf.py | 1 + docs/multiprocessing.rst | 4 ++-- noxfile.py | 6 ++++-- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index fdd7a26..ee47196 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -363,6 +363,7 @@ "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None,), "grpc": ("https://grpc.github.io/grpc/python/", None), "proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), } diff --git a/docs/multiprocessing.rst b/docs/multiprocessing.rst index 1cb29d4..536d17b 100644 --- a/docs/multiprocessing.rst +++ b/docs/multiprocessing.rst @@ -1,7 +1,7 @@ .. note:: - Because this client uses :mod:`grpcio` library, it is safe to + Because this client uses :mod:`grpc` library, it is safe to share instances across threads. In multiprocessing scenarios, the best practice is to create client instances *after* the invocation of - :func:`os.fork` by :class:`multiprocessing.Pool` or + :func:`os.fork` by :class:`multiprocessing.pool.Pool` or :class:`multiprocessing.Process`. diff --git a/noxfile.py b/noxfile.py index 70417e8..03aa2f5 100644 --- a/noxfile.py +++ b/noxfile.py @@ -179,7 +179,7 @@ def docs(session): """Build the docs for this library.""" session.install("-e", ".") - session.install("sphinx", "alabaster", "recommonmark") + session.install("sphinx==4.0.1", "alabaster", "recommonmark") shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) session.run( @@ -201,7 +201,9 @@ def docfx(session): """Build the docfx yaml files for this library.""" session.install("-e", ".") - session.install("sphinx", "alabaster", "recommonmark", "gcp-sphinx-docfx-yaml") + session.install( + "sphinx==4.0.1", "alabaster", "recommonmark", "gcp-sphinx-docfx-yaml" + ) shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) session.run(