| commit | 35a2bf9d90662e984780574f3f893cfaf68be501 | [log] [tgz] |
|---|---|---|
| author | Tim Swast <swast@google.com> | Thu Aug 15 16:22:02 2019 -0700 |
| committer | Tim Swast <swast@google.com> | Fri Feb 28 13:36:50 2020 -0600 |
| tree | eaf50eaeff4df9ee86de315b3b4ea8f4443da07f | |
| parent | ed19442270f623a60b7c7acc70d1f00cc8502254 [diff] |
python: publish sphinx docs to read the docs 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.
Copyright 2008 Google Inc.
https://developers.google.com/protocol-buffers/
Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. You can find protobuf's documentation on the Google Developers site.
This README file contains protobuf installation instructions. To install protobuf, you need to install the protocol compiler (used to compile .proto files) and the protobuf runtime for your chosen programming language.
The protocol compiler is written in C++. If you are using C++, please follow the C++ Installation Instructions to install protoc along with the C++ runtime.
For non-C++ users, the simplest way to install the protocol compiler is to download a pre-built binary from our release page:
https://github.com/protocolbuffers/protobuf/releases
In the downloads section of each release, you can find pre-built binaries in zip packages: protoc-$VERSION-$PLATFORM.zip. It contains the protoc binary as well as a set of standard .proto files distributed along with protobuf.
If you are looking for an old version that is not available in the release page, check out the maven repo here:
https://repo1.maven.org/maven2/com/google/protobuf/protoc/
These pre-built binaries are only provided for released versions. If you want to use the github master version at HEAD, or you need to modify protobuf code, or you are using C++, it's recommended to build your own protoc binary from source.
If you would like to build protoc binary from source, see the C++ Installation Instructions.
Protobuf supports several different programming languages. For each programming language, you can find instructions in the corresponding source directory about how to install protobuf runtime for that specific language:
| Language | Source | Ubuntu | MacOS | Windows |
|---|---|---|---|---|
| C++ (include C++ runtime and protoc) | src |    |   | |
| Java | java |     | ||
| Python | python |               |    |  |
| Objective-C | objectivec |     | ||
| C# | csharp |  |  | |
| JavaScript | js |  |  | |
| Ruby | ruby |      |      | |
| Go | golang/protobuf | |||
| PHP | php |   |   | |
| Dart | dart-lang/protobuf |  |
The best way to learn how to use protobuf is to follow the tutorials in our developer guide:
https://developers.google.com/protocol-buffers/docs/tutorials
If you want to learn from code examples, take a look at the examples in the examples directory.
The complete documentation for Protocol Buffers is available via the web at: