Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add summary_overview template #1946

Merged
merged 13 commits into from
Apr 5, 2024
2 changes: 1 addition & 1 deletion synthtool/gcp/templates/python_library/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Python Client for {{ metadata['repo']['name_pretty'] }} API
.. |versions| image:: https://img.shields.io/pypi/pyversions/{{ metadata['repo']['distribution_name'] }}.svg
:target: https://pypi.org/project/{{ metadata['repo']['distribution_name'] }}/
.. _{{ metadata['repo']['name_pretty'] }} API: {{ metadata['repo']['product_documentation'] }}
.. _Client Library Documentation: {{ metadata['repo']['client_documentation'] }}
.. _Client Library Documentation: {{ metadata['repo']['client_documentation'] }}/summary_overview
dandhlee marked this conversation as resolved.
Show resolved Hide resolved
.. _Product Documentation: {{ metadata['repo']['product_documentation'] }}

Quick Start
Expand Down
22 changes: 22 additions & 0 deletions synthtool/gcp/templates/python_library/docs/summary_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[
dandhlee marked this conversation as resolved.
Show resolved Hide resolved
This is a templated file. Adding content to this file may result in it being
reverted. Instead, if you want to place additional content, use
dandhlee marked this conversation as resolved.
Show resolved Hide resolved
"overview_content.md" file in `docs/` directory. The Sphinx tool will
pick up on the content and merge the content.
dandhlee marked this conversation as resolved.
Show resolved Hide resolved
]: #

# {{ metadata['repo']['name'] }} API

Overview of the APIs available for {{ metadata['repo']['name'] }} API.
dandhlee marked this conversation as resolved.
Show resolved Hide resolved

## All entries

Classes, methods and properties & attributes for
{{ metadata['repo']['name_pretty'] }} API.

[classes]({{ metadata['repo']['client_documentation'] }}/summary_class.html)

[methods]({{ metadata['repo']['client_documentation'] }}/summary_method.html)

[properties and
attributes]({{ metadata['repo']['client_documentation'] }}/summary_property.html)
dandhlee marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Python Client for {{ metadata['repo']['name_pretty'] }}
.. |versions| image:: https://img.shields.io/pypi/pyversions/{{ metadata['repo']['distribution_name'] }}.svg
:target: https://pypi.org/project/{{ metadata['repo']['distribution_name'] }}/
.. _{{ metadata['repo']['name_pretty'] }}: {{ metadata['repo']['product_documentation'] }}
.. _Client Library Documentation: {{ metadata['repo']['client_documentation'] }}
.. _Client Library Documentation: {{ metadata['repo']['client_documentation'] }}/summary_overview
.. _Product Documentation: {{ metadata['repo']['product_documentation'] }}

Quick Start
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[
This is a templated file. Adding content to this file may result in it being
reverted. Instead, if you want to place additional content, use
dandhlee marked this conversation as resolved.
Show resolved Hide resolved
"overview_content.md" file in `docs/` directory. The Sphinx tool will
pick up on the content and merge the content.
]: #

# {{ metadata['repo']['name'] }} API

Overview of the APIs available for {{ metadata['repo']['name'] }} API.
dandhlee marked this conversation as resolved.
Show resolved Hide resolved

## All entries

Classes, methods and properties & attributes for
{{ metadata['repo']['name_pretty'] }} API.

[classes]({{ metadata['repo']['client_documentation'] }}/summary_class.html)

[methods]({{ metadata['repo']['client_documentation'] }}/summary_method.html)

[properties and
attributes]({{ metadata['repo']['client_documentation'] }}/summary_property.html)
Loading