Skip to content

Commit

Permalink
Generate most non-appengine readmes
Browse files Browse the repository at this point in the history
Change-Id: I3779282126cdd05b047194d356932b9995484115
  • Loading branch information
Jon Wayne Parrott committed Oct 25, 2016
1 parent bfdab58 commit 2b7c061
Show file tree
Hide file tree
Showing 29 changed files with 1,135 additions and 542 deletions.
35 changes: 0 additions & 35 deletions bigquery/README.md

This file was deleted.

3 changes: 2 additions & 1 deletion bigquery/cloud-client/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@ To run this sample:
For more information, see the README.md under /bigquery.
Example invocation:
$ python async_query.py 'SELECT corpus FROM `publicdata.samples.shakespeare` GROUP BY corpus'
$ python async_query.py \
'SELECT corpus FROM `publicdata.samples.shakespeare` GROUP BY corpus'
positional arguments:
query BigQuery SQL Query.
Expand Down
87 changes: 0 additions & 87 deletions language/api/README.md

This file was deleted.

20 changes: 20 additions & 0 deletions language/api/README.rst.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# This file is used to generate README.rst

product:
name: Google Cloud Natural Language API
short_name: Cloud Natural Language API
url: https://cloud.google.com/natural-language/docs/
description: >
The `Google Cloud Natural Language API`_ provides natural language
understanding technologies to developers, including sentiment analysis,
entity recognition, and syntax analysis. This API is part of the larger
Cloud Machine Learning API.

setup:
- auth
- install_deps

samples:
- name: Analyze syntax
file: analyze.py
show_help: true
21 changes: 21 additions & 0 deletions language/cloud-client/README.rst.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# This file is used to generate README.rst

product:
name: Google Cloud Natural Language API
short_name: Cloud Natural Language API
url: https://cloud.google.com/natural-language/docs/
description: >
The `Google Cloud Natural Language API`_ provides natural language
understanding technologies to developers, including sentiment analysis,
entity recognition, and syntax analysis. This API is part of the larger
Cloud Machine Learning API.

setup:
- auth
- install_deps

samples:
- name: Quickstart
file: quickstart.py

cloud_client_library: true
38 changes: 0 additions & 38 deletions logging/api-client/README.md

This file was deleted.

14 changes: 14 additions & 0 deletions scripts/readme-gen/templates/auth_api_key.tmpl.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Authentication
++++++++++++++

Authentication for this service is done via an `API Key`_. To obtain an API
Key:

1. Open the `Cloud Platform Console`_
2. Make sure that billing is enabled for your project.
3. From the **Credentials** page, create a new **API Key** or use an existing
one for your project.

.. _API Key:
https://developers.google.com/api-client-library/python/guide/aaa_apikeys
.. _Cloud Console: https://console.cloud.google.com/project?_
26 changes: 26 additions & 0 deletions scripts/readme-gen/templates/install_portaudio.tmpl.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Install PortAudio
+++++++++++++++++

Install `PortAudio`_. This is required by the `PyAudio`_ library to stream
audio from your computer's microphone. PyAudio depends on PortAudio for cross-platform compatibility, and is installed differently depending on the
platform.

For Mac OS X, you can use `Homebrew`_::

brew install portaudio

For Debian / Ubuntu Linux::

apt-get install portaudio19-dev python-all-dev

Windows may work without having to install PortAudio explicitly (it will get
installed with PyAudio).

For more details, see the `PyAudio installation`_ page.


.. _PyAudio: https://people.csail.mit.edu/hubert/pyaudio/
.. _PortAudio: http://www.portaudio.com/
.. _PyAudio installation:
https://people.csail.mit.edu/hubert/pyaudio/#downloads
.. _Homebrew: http://brew.sh
14 changes: 0 additions & 14 deletions speech/README.md

This file was deleted.

85 changes: 0 additions & 85 deletions speech/api-client/README.md

This file was deleted.

Loading

0 comments on commit 2b7c061

Please sign in to comment.