Skip to content

Commit

Permalink
add/update rst files
Browse files Browse the repository at this point in the history
  • Loading branch information
parthea committed Jan 10, 2025
1 parent 1e24e65 commit af026f7
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 37 deletions.
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
{
"name": "accesscontextmanager",
"name_pretty": "Access Context Manager",
"client_documentation": "https://googleapis.dev/python/accesscontextmanager/latest",
"issue_tracker": "https://github.com/googleapis/python-access-context-manager/issues",
"client_documentation": "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-access-context-manager",
"product_documentation": "https://cloud.google.com/access-context-manager/docs/overview",
"issue_tracker": "https://github.com/googleapis/google-cloud-python/issues",
"release_level": "preview",
"language": "python",
"library_type": "GAPIC_AUTO",
"repo": "googleapis/python-access-context-manager",
"repo": "googleapis/google-cloud-python",
"distribution_name": "google-cloud-access-context-manager",
"default_version": "v1",
"codeowner_team": "",
Expand Down
24 changes: 12 additions & 12 deletions packages/google-cloud-access-context-manager/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,21 @@ Using a Development Checkout
You'll have to create a development environment using a Git checkout:

- While logged into your GitHub account, navigate to the
``python-access-context-manager`` `repo`_ on GitHub.
``google-cloud-python`` `repo`_ on GitHub.

- Fork and clone the ``python-access-context-manager`` repository to your GitHub account by
- Fork and clone the ``google-cloud-python`` repository to your GitHub account by
clicking the "Fork" button.

- Clone your fork of ``python-access-context-manager`` from your GitHub account to your local
- Clone your fork of ``google-cloud-python`` from your GitHub account to your local
computer, substituting your account username and specifying the destination
as ``hack-on-python-access-context-manager``. E.g.::
as ``hack-on-google-cloud-python``. E.g.::

$ cd ${HOME}
$ git clone [email protected]:USERNAME/python-access-context-manager.git hack-on-python-access-context-manager
$ cd hack-on-python-access-context-manager
# Configure remotes such that you can pull changes from the googleapis/python-access-context-manager
$ git clone [email protected]:USERNAME/google-cloud-python.git hack-on-google-cloud-python
$ cd hack-on-google-cloud-python
# Configure remotes such that you can pull changes from the googleapis/google-cloud-python
# repository into your local repository.
$ git remote add upstream [email protected]:googleapis/python-access-context-manager.git
$ git remote add upstream [email protected]:googleapis/google-cloud-python.git
# fetch and merge changes from upstream into main
$ git fetch upstream
$ git merge upstream/main
Expand All @@ -60,7 +60,7 @@ repo, from which you can submit a pull request.
To work on the codebase and run the tests, we recommend using ``nox``,
but you can also use a ``virtualenv`` of your own creation.

.. _repo: https://github.com/googleapis/python-access-context-manager
.. _repo: https://github.com/googleapis/google-cloud-python

Using ``nox``
=============
Expand Down Expand Up @@ -113,7 +113,7 @@ Coding Style
export GOOGLE_CLOUD_TESTING_BRANCH="main"

By doing this, you are specifying the location of the most up-to-date
version of ``python-access-context-manager``. The
version of ``google-cloud-python``. The
remote name ``upstream`` should point to the official ``googleapis``
checkout and the branch should be the default branch on that remote (``main``).

Expand Down Expand Up @@ -209,7 +209,7 @@ The `description on PyPI`_ for the project comes directly from the
``README``. Due to the reStructuredText (``rst``) parser used by
PyPI, relative links which will work on GitHub (e.g. ``CONTRIBUTING.rst``
instead of
``https://github.com/googleapis/python-access-context-manager/blob/main/CONTRIBUTING.rst``)
``https://github.com/googleapis/google-cloud-python/blob/main/CONTRIBUTING.rst``)
may cause problems creating links or rendering the description.

.. _description on PyPI: https://pypi.org/project/google-cloud-access-context-manager
Expand Down Expand Up @@ -240,7 +240,7 @@ We support:

Supported versions can be found in our ``noxfile.py`` `config`_.

.. _config: https://github.com/googleapis/python-access-context-manager/blob/main/packages/google-cloud-access-context-manager/noxfile.py
.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-access-context-manager/noxfile.py


**********
Expand Down
1 change: 0 additions & 1 deletion packages/google-cloud-access-context-manager/README.md

This file was deleted.

10 changes: 5 additions & 5 deletions packages/google-cloud-access-context-manager/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Python Client for Access Context Manager
:target: https://pypi.org/project/google-cloud-access-context-manager/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-access-context-manager.svg
:target: https://pypi.org/project/google-cloud-access-context-manager/
.. _Access Context Manager:
.. _Client Library Documentation: https://googleapis.dev/python/accesscontextmanager/latest
.. _Product Documentation:
.. _Access Context Manager: https://cloud.google.com/access-context-manager/docs/overview
.. _Client Library Documentation: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-access-context-manager
.. _Product Documentation: https://cloud.google.com/access-context-manager/docs/overview

Quick Start
-----------
Expand All @@ -30,7 +30,7 @@ In order to use this library, you first need to go through the following steps:

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Access Context Manager.:
.. _Enable the Access Context Manager.: https://cloud.google.com/access-context-manager/docs/overview
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
Expand Down Expand Up @@ -104,5 +104,5 @@ Next Steps
- View this `README`_ to see the full list of Cloud
APIs that we cover.

.. _Access Context Manager Product documentation:
.. _Access Context Manager Product documentation: https://cloud.google.com/access-context-manager/docs/overview
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst

This file was deleted.

2 changes: 1 addition & 1 deletion packages/google-cloud-access-context-manager/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@
html_theme_options = {
"description": "Google Cloud Client Libraries for google-cloud-access-context-manager",
"github_user": "googleapis",
"github_repo": "python-access-context-manager",
"github_repo": "google-cloud-python",
"github_banner": True,
"font_family": "'Roboto', Georgia, sans",
"head_font_family": "'Roboto', Georgia, serif",
Expand Down
4 changes: 2 additions & 2 deletions packages/google-cloud-access-context-manager/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ API Reference
.. toctree::
:maxdepth: 2

v1/services_
v1/types_
type
v1


Changelog
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-access-context-manager/docs/type.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
google.identity.accesscontextmanager.type
=========================================

.. automodule:: google.identity.accesscontextmanager.type.device_resources_pb2
.. automodule:: google.identity.accesscontextmanager.type
:members:
:inherited-members:
11 changes: 1 addition & 10 deletions packages/google-cloud-access-context-manager/docs/v1.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,7 @@
google.identity.accesscontextmanager.v1
========================================

.. automodule:: google.identity.accesscontextmanager.v1.access_level_pb2
.. automodule:: google.identity.accesscontextmanager.v1
:members:
:inherited-members:


.. automodule:: google.identity.accesscontextmanager.v1.access_policy_pb2
:members:
:inherited-members:


.. automodule:: google.identity.accesscontextmanager.v1.service_perimeter_pb2
:members:
:inherited-members:
2 changes: 1 addition & 1 deletion packages/google-cloud-access-context-manager/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
# Setup boilerplate below this line.
package_root = os.path.abspath(os.path.dirname(__file__))

readme_filename = os.path.join(package_root, "README.md")
readme_filename = os.path.join(package_root, "README.rst")
with io.open(readme_filename, encoding="utf-8") as readme_file:
readme = readme_file.read()

Expand Down

0 comments on commit af026f7

Please sign in to comment.