Skip to content

Commit

Permalink
Docs: Replace links to '/stable/' with '/latest/'. (#5901)
Browse files Browse the repository at this point in the history
* Replace links to '/stable/' with '/latest/'.

* DRY out duplicated 'README.rst' vs. 'docs/index.rst'.

* Include websecurityscanner in docs.

Toward #5894.
  • Loading branch information
tseaver authored Sep 10, 2018
1 parent 21d1a91 commit 7bbf88a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 79 deletions.
6 changes: 3 additions & 3 deletions packages/google-cloud-texttospeech/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ models.

.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. _Cloud Text-to-Speech API: https://cloud.google.com/texttospeech
.. _Client Library Documentation: https://google-cloud-python.readthedocs.io/en/latest/texttospeech/index.html
.. _Product Documentation: https://cloud.google.com/texttospeech
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/texttospeech/api.html
.. _Product Documentation: https://cloud.google.com/texttospeech

Quick Start
-----------
Expand All @@ -25,7 +25,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 Cloud Text-to-Speech API.: https://cloud.google.com/texttospeech
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/core/auth.html
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html

Installation
~~~~~~~~~~~~
Expand Down
77 changes: 1 addition & 76 deletions packages/google-cloud-texttospeech/docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,79 +1,4 @@
Python Client for Cloud Text-to-Speech API (`Alpha`_)
=====================================================

`Cloud Text-to-Speech API`_: Synthesizes natural-sounding speech by applying powerful neural network
models.

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

.. _Alpha: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. _Cloud Text-to-Speech API: https://cloud.google.com/texttospeech
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/texttospeech/api.html
.. _Product Documentation: https://cloud.google.com/texttospeech

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 Cloud Text-to-Speech 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 Cloud Text-to-Speech API.: https://cloud.google.com/texttospeech
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/stable/core/auth.html

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-texttospeech
Windows
^^^^^^^

.. code-block:: console
pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-texttospeech
Next Steps
~~~~~~~~~~

- Read the `Client Library Documentation`_ for Cloud Text-to-Speech API
API to see other available methods on the client.
- Read the `Cloud Text-to-Speech 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.

.. _Cloud Text-to-Speech API Product documentation: https://cloud.google.com/texttospeech
.. _repository’s main README: https://github.com/GoogleCloudPlatform/google-cloud-python/blob/master/README.rst
.. include:: /../texttospeech/README.rst

Api Reference
-------------
Expand Down

0 comments on commit 7bbf88a

Please sign in to comment.