35a2bf9d90
Background: This is a follow-up to the PR that adds sphinx docs. Read the Docs is a hosting platform for documentation, primarily Python docs. It supports builds at commit time as well as at specific git labels to support versioned docs. I have claimed the protobuf.readthedocs.io project and can add any Googlers who need access to be able to configure and trigger builds. https://readthedocs.org/projects/protobuf/builds/ It's also relatively easy to create a new project to test the documentation builds from a fork, such as https://readthedocs.org/projects/tswast-protobuf/builds/ About this change: Once web hooks are configured, Read the Docs will automatically build the docs for the latest changes on the master branch. I needed to update `python/setup.py` to support installation from the root of the repository because Read the Docs does not `cd python` before installing the protobuf package with `setup.py install`. To support this, I updated the file paths to use the absolute path to files. The `__file__` special variable comes in handy for this, as it provides the path to the `setup.py` file. A banner is added to the docs when published to readthedocs. This links to the official documentation and the future home of the stable API reference on googleapis.dev.
63 lines
1.8 KiB
ReStructuredText
63 lines
1.8 KiB
ReStructuredText
.. Protocol Buffers documentation master file, created by
|
|
sphinx-quickstart on Thu Aug 15 13:56:43 2019.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
.. ifconfig:: build_env == 'readthedocs'
|
|
|
|
.. warning::
|
|
|
|
You are reading the documentation for the `latest committed changes
|
|
<https://github.com/protocolbuffers/protobuf/tree/master/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/>`_.
|
|
|
|
Protocol Buffers Python API Reference
|
|
=====================================
|
|
|
|
The complete documentation for Protocol Buffers is available via the web at:
|
|
|
|
https://developers.google.com/protocol-buffers/
|
|
|
|
|
|
Modules and Packages
|
|
--------------------
|
|
|
|
.. START REFTOC, generated by generate_docs.py.
|
|
.. toctree::
|
|
|
|
google/protobuf
|
|
google/protobuf/any_pb2
|
|
google/protobuf/descriptor
|
|
google/protobuf/descriptor_database
|
|
google/protobuf/descriptor_pb2
|
|
google/protobuf/descriptor_pool
|
|
google/protobuf/duration_pb2
|
|
google/protobuf/empty_pb2
|
|
google/protobuf/field_mask_pb2
|
|
google/protobuf/json_format
|
|
google/protobuf/message
|
|
google/protobuf/message_factory
|
|
google/protobuf/proto_builder
|
|
google/protobuf/reflection
|
|
google/protobuf/service
|
|
google/protobuf/service_reflection
|
|
google/protobuf/struct_pb2
|
|
google/protobuf/symbol_database
|
|
google/protobuf/text_encoding
|
|
google/protobuf/text_format
|
|
google/protobuf/timestamp_pb2
|
|
google/protobuf/type_pb2
|
|
google/protobuf/wrappers_pb2
|
|
|
|
.. END REFTOC.
|
|
|
|
Indices and tables
|
|
------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|