diff options
author | chojoyce <chojoyce@google.com> | 2021-12-24 12:12:02 +0800 |
---|---|---|
committer | chojoyce <chojoyce@google.com> | 2022-01-04 18:13:08 +0800 |
commit | 4e81cd9cc2fd5700fad778754c7db0b34f9fe04f (patch) | |
tree | 412a59ade78bcacc2449642d7cfd7ccb6a92d8e4 /scripts/readme-gen/templates/README.tmpl.rst | |
parent | d4dcb747f8ac4df33c321b19ee1c511f6e47707e (diff) | |
parent | cb091f8669124be83df78424afed442b37767acc (diff) | |
download | python-api-core-4e81cd9cc2fd5700fad778754c7db0b34f9fe04f.tar.gz |
Merge platform/external/python/python-api-core v2.3.0
Inital commit of python-api-core 2.3.0 with history
Added:
- Android.bp
- MODULE_LICENSE_APACHE2
- NOTICE
- METADATA
Bug: 154879379
Bug: 209463871
Test: None
Change-Id: I5060e5ab4c8ebec256df4fb7a75a2ed03b5abbf4
Diffstat (limited to 'scripts/readme-gen/templates/README.tmpl.rst')
-rw-r--r-- | scripts/readme-gen/templates/README.tmpl.rst | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/scripts/readme-gen/templates/README.tmpl.rst b/scripts/readme-gen/templates/README.tmpl.rst new file mode 100644 index 0000000..4fd2397 --- /dev/null +++ b/scripts/readme-gen/templates/README.tmpl.rst @@ -0,0 +1,87 @@ +{# The following line is a lie. BUT! Once jinja2 is done with it, it will + become truth! #} +.. This file is automatically generated. Do not edit this file directly. + +{{product.name}} Python Samples +=============================================================================== + +.. image:: https://gstatic.com/cloudssh/images/open-btn.png + :target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor={{folder}}/README.rst + + +This directory contains samples for {{product.name}}. {{product.description}} + +{{description}} + +.. _{{product.name}}: {{product.url}} + +{% if required_api_url %} +To run the sample, you need to enable the API at: {{required_api_url}} +{% endif %} + +{% if required_role %} +To run the sample, you need to have `{{required_role}}` role. +{% endif %} + +{{other_required_steps}} + +{% if setup %} +Setup +------------------------------------------------------------------------------- + +{% for section in setup %} + +{% include section + '.tmpl.rst' %} + +{% endfor %} +{% endif %} + +{% if samples %} +Samples +------------------------------------------------------------------------------- + +{% for sample in samples %} +{{sample.name}} ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +{% if not sample.hide_cloudshell_button %} +.. image:: https://gstatic.com/cloudssh/images/open-btn.png + :target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor={{folder}}/{{sample.file}},{{folder}}/README.rst +{% endif %} + + +{{sample.description}} + +To run this sample: + +.. code-block:: bash + + $ python {{sample.file}} +{% if sample.show_help %} + + {{get_help(sample.file)|indent}} +{% endif %} + + +{% endfor %} +{% endif %} + +{% if cloud_client_library %} + +The client library +------------------------------------------------------------------------------- + +This sample uses the `Google Cloud Client Library for Python`_. +You can read the documentation for more details on API usage and use GitHub +to `browse the source`_ and `report issues`_. + +.. _Google Cloud Client Library for Python: + https://googlecloudplatform.github.io/google-cloud-python/ +.. _browse the source: + https://github.com/GoogleCloudPlatform/google-cloud-python +.. _report issues: + https://github.com/GoogleCloudPlatform/google-cloud-python/issues + +{% endif %} + +.. _Google Cloud SDK: https://cloud.google.com/sdk/
\ No newline at end of file |