| commit | 6b6acb39c69ca713420454a2e78d90e327cad08f | [log] [tgz] |
|---|---|---|
| author | Fabian Meumertzheim <fabian@meumertzhe.im> | Tue Jul 18 17:08:10 2023 +0200 |
| committer | GitHub <noreply@github.com> | Tue Jul 18 11:08:10 2023 -0400 |
| tree | 9dcbc2ae754f860ced3dd2c9e347fa0c3259db5e | |
| parent | 1527ba02e9e00ef53f1703f8b2bcfa2189da4f74 [diff] |
Do not HTML-escape and use Markdown inline code for defaults (#161) Reverts #133 so that HTML escaping is not applied to Markdown. Instead, Markdown content such as docstrings can use HTML formatting and escape angle brackets with backslashes, HTML entities or inline code segments. Default values are embedded in inline code segments instead of `<code>` tags, which does not require escaping. As a result, docstrings behave just like regular Markdown contexts while default values are rendered without smart quotes and can contain both `<` and `` ` `` without causing escaping issues. Also includes tests based on #138. Fixes #137 Closes #138 Fixes #142 Closes #143 Requires https://github.com/bazelbuild/bazel/pull/18867 Co-authored-by: Adam Azarchs <adam.azarchs@10xgenomics.com>
Stardoc is a documentation generator for Bazel build rules written in Starlark.
Stardoc provides a Starlark rule (stardoc, see documentation) that can be used to build documentation for Starlark rules in Markdown. Stardoc generates one documentation page per .bzlfile.
Stardoc is a replacement for the deprecated “Skydoc” documentation generator.
See Skydoc Deprecation for details on the deprecation and migration details.
See our future plans for refactoring Stardoc to be more consistent with how Bazel evaluates .bzl files, and what it means for maintenance of this project.
See the maintaner's guide for instructions for cutting a new release.