29c83baecc
* python: generate documentation with Sphinx and Read the Docs Background: Formerly, the Python protobuf reference documentation was built with [Epydoc](http://epydoc.sourceforge.net/). This package has not been updated since 2008, and it has inconsistent formatting (see internal issue 131415575) with most Python documentation. Sphinx is used for the official docs.python.org docs as well as most other Python packages, including the Google client libraries and related packages, such as https://googleapis.dev/python/google-api-core/latest/ To build the docs with Sphinx: 1. Install the needed packages (`sphinx`, `sphinxcontrib-napoleon` for Google-style docstring support). I've created a conda environment file to make this easier: ``` conda env create -f python/docs/environment.yml ``` 2. (Optional) Generate reference docs files and regenerate index: ``` cd python python generate_docs.py cd .. ``` 3. Run Sphinx. ``` cd python/docs make html ``` About this change: The script at `python/generate_docs.py` creates a ReStructured Text file for each public module in the protobuf Python package. The script also updates the table of contents in `python/docs/index.rst` to point to these module references. Future work: Testing the docs build on PRs requires contributors to actually do some setup work to configure builds on their fork. It'd be better if CI had a docs build session to verify that the Sphinx docs generation at least runs. There are many warnings due to not-quite-correct docstrings in the actual Python code itself. I'm choosing to ignore these errors to keep the PR small, but I recommend you fix these and then enable "fail on warnings" in the docs build on CI. * add docs to EXTRA_DIST * add instructions to build documentation to generate_docs.py * exclude python/odcs from cpp_distcheck
51 lines
1.3 KiB
ReStructuredText
51 lines
1.3 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.
|
|
|
|
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`
|