sabledocs

5.4easy start · #22 of 23
in gRPC Tools

sabledocs is ranked #22 of 23 in gRPC tools on The Geeks Club.

Compared on gRPC tools

Kreya 0 of 4 in the starter kit Lesson 17.9 FintX 0 of 4 in the starter kit Lesson 27.2 ghz 0 of 4 in the starter kit Lesson 37.2 grpcmd 0 of 4 in the starter kit Lesson 47.2 ProtoCall 0 of 4 in the starter kit Lesson 57.1 Bandura 0 of 4 in the starter kit Lesson 67.0

Purpose: Sabledocs is a static documentation generator for Protobuf and gRPC contracts.
Free and open source: The demo page describes Sabledocs as free and open source.
Generation: Sabledocs uses a command-line interface to generate static HTML documentation.
Multiple packages: It can build one documentation site for multiple packages.
Contract support: It can combine Protobuf and gRPC contracts in generated documentation.
Prerequisite: The package requires Python 3.11 or higher, and the build process uses a binary descriptor generated with protoc.
Search: Search can be enabled with a prebuilt Lunr index and is enabled by default.
Markdown: Markdown is supported in the main content page and in Protobuf comments.
Source links: Configuration can add source code links for Protobuf model members, with GitHub, Bitbucket, Bitbucket Data Center, and GitLab repository types supported.
Docker: A Docker image is available with both protoc and Sabledocs preinstalled.
Custom templates: Users can configure Jinja templates for primary content and add extra templates to generated output.
Comment parsing: An advanced option lets users preprocess Protobuf comments with a custom Python parser; the page cautions that this may make whitespace-sensitive formatting harder.

Claim it for free: prove the domain, then correct facts, plans and screenshots. An editor reviews every change.