Improve Stardoc docs to cover all public APIs - #213
Open
ryanulep wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces the old
docs/attrs.md(a hand-rolled attributes table covering only thedetektrule) with a comprehensivedocs/rules_detekt.mdgenerated by Stardoc, covering all public APIs:detekt,detekt_test,detekt_create_baseline,detekt_toolchain,rules_detekt_toolchains, anddetekt_version.Changes
docs/BUILD: Add separatestardoctargets fordefs.bzl,toolchain.bzl,toolchains.bzl, andversions.bzl; combine them via agenruleinto a singlerules_detekt.mdoutput. Removethe 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.md→docs/rules_detekt.md: Replace old hand-maintained file with the regenerated output.detekt/BUILD: Export all public.bzlfiles so Stardoc can read them.detekt/defs.bzl: Adddocstrings todetekt,detekt_test, anddetekt_create_baselinerules; remove theis_androidattr (superseded byenable_type_resolution); polish existing attrdoc strings.
detekt/toolchain.bzl,detekt/toolchains.bzl,detekt/versions.bzl: Add/improvedocstrings on rules and macros.MODULE.bazel: Bumpstardocdev dependency from0.7.2→0.8.1.README.md: Update links fromdocs/attrs.mdtodocs/rules_detekt.md; fixrules_detekt_dependenciesparameter name (detekt_version→detekt).