Skip to content

Commit

Permalink
Merge pull request #10167 from shaod2/master
Browse files Browse the repository at this point in the history
Fix to generate Python gendocs.
  • Loading branch information
shaod2 authored Jun 22, 2022
2 parents 046bde0 + 1275ce8 commit 352444e
Show file tree
Hide file tree
Showing 27 changed files with 57 additions and 24 deletions.
11 changes: 11 additions & 0 deletions python/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "protobuf",
"name_pretty": "Protocol Buffers",
"product_documentation": "https://developers.google.com/protocol-buffers ",
"client_documentation": "https://developers.google.com/protocol-buffers/docs/pythontutorial",
"issue_tracker": "https://github.com/protocolbuffers/protobuf/issues",
"release_level": "ga",
"language": "python",
"repo": "protocolbuffers/protobuf ",
"distribution_name": "protobuf"
}
2 changes: 1 addition & 1 deletion python/docs/google/protobuf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/any_pb2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/descriptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/descriptor_database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/descriptor_pb2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/descriptor_pool.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/duration_pb2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/empty_pb2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/field_mask_pb2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/internal/containers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/json_format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/message.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/message_factory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/proto_builder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/reflection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/service_reflection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/struct_pb2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/symbol_database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/text_encoding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/text_format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/timestamp_pb2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/type_pb2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
21 changes: 21 additions & 0 deletions python/docs/google/protobuf/unknown_fields.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. DO NOT EDIT, generated by generate_docs.py.
.. ifconfig:: build_env == 'readthedocs'

.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
latest released package at `googleapis.dev
<https://googleapis.dev/python/protobuf/latest/>`_.

google.protobuf.unknown_fields
==============================

.. automodule:: google.protobuf.unknown_fields
:members:
:inherited-members:
:undoc-members:
2 changes: 1 addition & 1 deletion python/docs/google/protobuf/wrappers_pb2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.. warning::

You are reading the documentation for the `latest committed changes
<https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
<https://github.com/protocolbuffers/protobuf/tree/main/python>`_ of
the `Protocol Buffers package for Python
<https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
Some features may not yet be released. Read the documentation for the
Expand Down
1 change: 1 addition & 0 deletions python/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ Modules and Packages
google/protobuf/text_format
google/protobuf/timestamp_pb2
google/protobuf/type_pb2
google/protobuf/unknown_fields
google/protobuf/wrappers_pb2

.. END REFTOC.
Expand Down

0 comments on commit 352444e

Please sign in to comment.