Skip to content

Latest commit

 

History

History
60 lines (35 loc) · 2.13 KB

docs.md

File metadata and controls

60 lines (35 loc) · 2.13 KB

Public API for docs helpers

stardoc_with_diff_test

stardoc_with_diff_test(name, bzl_library_target, kwargs)

Creates a stardoc target that can be auto-detected by update_docs to write the generated doc to the source tree and test that it's up to date.

This is helpful for minimizing boilerplate in repos with lots of stardoc targets.

PARAMETERS

Name Description Default Value
name the name of the stardoc file to be written to the current source directory (.md will be appended to the name). Call bazel run on this target to update the file. none
bzl_library_target the label of the bzl_library target to generate documentation for none
kwargs additional attributes passed to the stardoc() rule, such as for overriding the templates none

update_docs

update_docs(name, kwargs)

Stamps an executable run for writing all stardocs declared with stardoc_with_diff_test to the source tree.

This is to be used in tandem with stardoc_with_diff_test() to produce a convenient workflow for generating, testing, and updating all doc files as follows:

bazel build //{docs_folder}/... && bazel test //{docs_folder}/... && bazel run //{docs_folder}:update

eg.

bazel build //docs/... && bazel test //docs/... && bazel run //docs:update

PARAMETERS

Name Description Default Value
name the name of executable target "update"
kwargs Other common named parameters such as tags or visibility none