Skip to content

Improve Stardoc docs to cover all public APIs - #213

Open
ryanulep wants to merge 2 commits into
buildfoundation:masterfrom
ryanulep:stardoc
Open

Improve Stardoc docs to cover all public APIs#213
ryanulep wants to merge 2 commits into
buildfoundation:masterfrom
ryanulep:stardoc

Conversation

@ryanulep

Copy link
Copy Markdown
Contributor

Replaces the old docs/attrs.md (a hand-rolled attributes table covering only the detekt rule) with a comprehensive docs/rules_detekt.md generated by Stardoc, covering all public APIs: detekt,
detekt_test, detekt_create_baseline, detekt_toolchain, rules_detekt_toolchains, and detekt_version.

Changes

  • docs/BUILD: Add separate stardoc targets for defs.bzl, toolchain.bzl, toolchains.bzl, and versions.bzl; combine them via a genrule into a single rules_detekt.md output. Remove
    the custom rule_template.vm (no longer needed now that Stardoc's default output format is used).
  • docs/generate.sh: Update to move the new generated file.
  • docs/attrs.mddocs/rules_detekt.md: Replace old hand-maintained file with the regenerated output.
  • detekt/BUILD: Export all public .bzl files so Stardoc can read them.
  • detekt/defs.bzl: Add doc strings to detekt, detekt_test, and detekt_create_baseline rules; remove the is_android attr (superseded by enable_type_resolution); polish existing attr
    doc strings.
  • detekt/toolchain.bzl, detekt/toolchains.bzl, detekt/versions.bzl: Add/improve doc strings on rules and macros.
  • MODULE.bazel: Bump stardoc dev dependency from 0.7.20.8.1.
  • README.md: Update links from docs/attrs.md to docs/rules_detekt.md; fix rules_detekt_dependencies parameter name (detekt_versiondetekt).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant