Skip to content

Commit adccba0

Browse files
authored
Normalize docs. (#8994)
* 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.
1 parent 2da870e commit adccba0

File tree

6 files changed

+17
-153
lines changed

6 files changed

+17
-153
lines changed

containeranalysis/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ and retrieval of critical metadata about all of your software artifacts.
99

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

1515
Quick Start
@@ -73,4 +73,4 @@ Next Steps
7373
APIs that we cover.
7474

7575
.. _Container Analysis API Product documentation: https://cloud.google.com/container-registry/docs/container-analysis
76-
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
76+
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst

containeranalysis/docs/README.rst

Lines changed: 0 additions & 76 deletions
This file was deleted.

containeranalysis/docs/README.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.rst

monitoring/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ with a few exceptions as noted on the individual method pages.
2020
.. |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
2121
:target: https://python-compatibility-tools.appspot.com/one_badge_target?package=git%2Bgit%3A//github.com/googleapis/google-cloud-python.git%23subdirectory%3Dmonitoring
2222
.. _Stackdriver Monitoring API: https://cloud.google.com/monitoring/api/ref_v3/rest/
23-
.. _Client Library Documentation: https://google-cloud-python.readthedocs.io/en/latest/monitoring/
23+
.. _Client Library Documentation: https://googleapis.dev/python/monitoring/latest
2424
.. _Product Documentation: https://cloud.google.com/monitoring/docs
2525

2626
Quick Start

phishingprotection/docs/README.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.rst
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CHANGELOG.md

phishingprotection/docs/index.rst

Lines changed: 11 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,20 @@
1-
Python Client for Phishing Protection API (`Alpha`_)
2-
====================================================
1+
.. include:: README.rst
32

4-
`Phishing Protection API`_:
5-
6-
- `Client Library Documentation`_
7-
- `Product Documentation`_
8-
9-
.. _Alpha: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
10-
.. _Phishing Protection API: https://cloud.google.com/phishingprotection
11-
.. _Client Library Documentation: https://googleapis.dev/python/phishingprotection/latest
12-
.. _Product Documentation: https://cloud.google.com/phishingprotection
13-
14-
Quick Start
15-
-----------
16-
17-
In order to use this library, you first need to go through the following steps:
18-
19-
1. `Select or create a Cloud Platform project.`_
20-
2. `Enable billing for your project.`_
21-
3. `Enable the Phishing Protection API.`_
22-
4. `Setup Authentication.`_
23-
24-
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
25-
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
26-
.. _Enable the Phishing Protection API.: https://cloud.google.com/phishingprotection
27-
.. _Setup Authentication.: https://googleapis.dev/python/phishingprotection/latest
28-
29-
Installation
30-
~~~~~~~~~~~~
31-
32-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
33-
create isolated Python environments. The basic problem it addresses is one of
34-
dependencies and versions, and indirectly permissions.
35-
36-
With `virtualenv`_, it's possible to install this library without needing system
37-
install permissions, and without clashing with the installed system
38-
dependencies.
39-
40-
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
41-
42-
43-
Mac/Linux
44-
^^^^^^^^^
45-
46-
.. code-block:: console
47-
48-
pip install virtualenv
49-
virtualenv <your-env>
50-
source <your-env>/bin/activate
51-
<your-env>/bin/pip install google-cloud-phishingprotection
52-
53-
54-
Windows
55-
^^^^^^^
56-
57-
.. code-block:: console
3+
Api Reference
4+
-------------
5+
.. toctree::
6+
:maxdepth: 2
587

59-
pip install virtualenv
60-
virtualenv <your-env>
61-
<your-env>\Scripts\activate
62-
<your-env>\Scripts\pip.exe install google-cloud-phishingprotection
8+
gapic/v1beta1/api
9+
gapic/v1beta1/types
6310

64-
Next Steps
65-
~~~~~~~~~~
6611

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

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

77-
Api Reference
78-
-------------
7917
.. toctree::
8018
:maxdepth: 2
8119

82-
gapic/v1beta1/api
83-
gapic/v1beta1/types
20+
changelog

0 commit comments

Comments
 (0)