Skip to content

Commit

Permalink
Normalize docs. (#8994)
Browse files Browse the repository at this point in the history
* Make 'containeranalysis/docs/README.rst' a symlink.

* DRY 'phishinprotection/docs/index.rst', include changelog.

* Update 'monitoring/README.rst' to use googleapis.dev URL.

See #8993.
  • Loading branch information
tseaver authored Aug 8, 2019
1 parent 2da870e commit adccba0
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 153 deletions.
4 changes: 2 additions & 2 deletions containeranalysis/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and retrieval of critical metadata about all of your software artifacts.

.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
.. _Container Analysis API: https://cloud.google.com/container-registry/docs/container-analysis
.. _Client Library Documentation: https://googleapis.dev/python/containeranalysis/latest/index.html
.. _Client Library Documentation: https://googleapis.dev/python/containeranalysis/latest
.. _Product Documentation: https://cloud.google.com/container-registry/docs/container-analysis

Quick Start
Expand Down Expand Up @@ -73,4 +73,4 @@ Next Steps
APIs that we cover.

.. _Container Analysis API Product documentation: https://cloud.google.com/container-registry/docs/container-analysis
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
76 changes: 0 additions & 76 deletions containeranalysis/docs/README.rst

This file was deleted.

1 change: 1 addition & 0 deletions containeranalysis/docs/README.rst
2 changes: 1 addition & 1 deletion monitoring/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ with a few exceptions as noted on the individual method pages.
.. |compat_check_github| image:: https://python-compatibility-tools.appspot.com/one_badge_image?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dmonitoring
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dmonitoring
.. _Stackdriver Monitoring API: https://cloud.google.com/monitoring/api/ref_v3/rest/
.. _Client Library Documentation: https://google-cloud-python.readthedocs.io/en/latest/monitoring/
.. _Client Library Documentation: https://googleapis.dev/python/monitoring/latest
.. _Product Documentation: https://cloud.google.com/monitoring/docs

Quick Start
Expand Down
1 change: 1 addition & 0 deletions phishingprotection/docs/README.rst
1 change: 1 addition & 0 deletions phishingprotection/docs/changelog.md
85 changes: 11 additions & 74 deletions phishingprotection/docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,83 +1,20 @@
Python Client for Phishing Protection API (`Alpha`_)
====================================================
.. include:: README.rst

`Phishing Protection API`_:

- `Client Library Documentation`_
- `Product Documentation`_

.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
.. _Phishing Protection API: https://cloud.google.com/phishingprotection
.. _Client Library Documentation: https://googleapis.dev/python/phishingprotection/latest
.. _Product Documentation: https://cloud.google.com/phishingprotection

Quick Start
-----------

In order to use this library, you first need to go through the following steps:

1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Phishing Protection API.`_
4. `Setup Authentication.`_

.. _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 Phishing Protection API.: https://cloud.google.com/phishingprotection
.. _Setup Authentication.: https://googleapis.dev/python/phishingprotection/latest

Installation
~~~~~~~~~~~~

Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
create isolated Python environments. The basic problem it addresses is one of
dependencies and versions, and indirectly permissions.

With `virtualenv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.

.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/


Mac/Linux
^^^^^^^^^

.. code-block:: console
pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-phishingprotection
Windows
^^^^^^^

.. code-block:: console
Api Reference
-------------
.. toctree::
:maxdepth: 2

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-phishingprotection
gapic/v1beta1/api
gapic/v1beta1/types

Next Steps
~~~~~~~~~~

- Read the `Client Library Documentation`_ for Phishing Protection API
API to see other available methods on the client.
- Read the `Phishing Protection API Product documentation`_ to learn
more about the product and see How-to Guides.
- View this `repository’s main README`_ to see the full list of Cloud
APIs that we cover.
Changelog
----------

.. _Phishing Protection API Product documentation: https://cloud.google.com/phishingprotection
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
For all previous ``google-cloud-phishingprotection`` releases:

Api Reference
-------------
.. toctree::
:maxdepth: 2

gapic/v1beta1/api
gapic/v1beta1/types
changelog

0 comments on commit adccba0

Please sign in to comment.