Skip to content

Commit

Permalink
[stardoc] Update stardoc to 0.7.0 (#1214)
Browse files Browse the repository at this point in the history
* [stardoc] Update stardoc to 7.0.0

Of special note:
> The Markdown renderer now uses Google EscapeVelocity instead of Apache Velocity for templating. The templating engines are almost compatible, with the exception of escapes in string literals: if in your template you had a string literal with a character escape, you would need to expand it.

[Release Notes for 0.6.0](https://github.com/bazelbuild/stardoc/releases/tag/0.6.0)

"almost", indeed. :/

fixes #1203

* Move docs test to bzlmod only

* make are the docs upto date manual

* Stop using custom template

* Update anvil?

* exclude anvil
  • Loading branch information
restingbull authored Sep 11, 2024
1 parent cff2e6f commit 7b2ba28
Show file tree
Hide file tree
Showing 8 changed files with 353 additions and 364 deletions.
2 changes: 2 additions & 0 deletions .bazelci/presubmit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ tasks:
stardoc:
name: Stardoc api documentation
platform: ubuntu1804
build_flags:
- "--enable_bzlmod=true"
build_targets:
- //kotlin:stardoc
test_targets:
Expand Down
1 change: 0 additions & 1 deletion BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ ktlint_config(
test_suite(
name = "all_tests",
tests = [
"//docs:are_docs_up_to_date_test",
"//src/test/kotlin/io/bazel/kotlin:assertion_tests",
"//src/test/kotlin/io/bazel/kotlin/builder:builder_tests",
"//src/test/kotlin/io/bazel/kotlin/integration:integration_tests",
Expand Down
2 changes: 1 addition & 1 deletion MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ maven.install(
use_repo(maven, "kotlin_rules_maven", "unpinned_kotlin_rules_maven")

bazel_dep(name = "rules_pkg", version = "0.7.0")
bazel_dep(name = "stardoc", version = "0.5.6", repo_name = "io_bazel_stardoc")
bazel_dep(name = "stardoc", version = "0.7.0", repo_name = "io_bazel_stardoc")
bazel_dep(name = "rules_proto", version = "5.3.0-21.7")

bazel_dep(name = "rules_testing", version = "0.5.0", dev_dependency = True)
Expand Down
1 change: 1 addition & 0 deletions docs/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ sh_test(
"kotlin.md",
"//kotlin:stardoc",
],
tags = ["manual"],
)
663 changes: 347 additions & 316 deletions docs/kotlin.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions examples/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ genrule(
"*",
# Node is currently broken.
"node/**",
# Jetpack compose is in an ambigious state due to the android rules migration
#"jetpack_compose/**",
# Anvil is broken by a verison upgrade.
"anvil/**",
],
)
}
Expand Down
1 change: 0 additions & 1 deletion kotlin/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ release_archive(
name = doc,
out = "%s.md" % doc,
input = "%s.bzl" % doc,
rule_template = "//kotlin:doc-templates/rule.vm",
deps = [
"//kotlin/internal",
],
Expand Down
43 changes: 0 additions & 43 deletions kotlin/doc-templates/rule.vm

This file was deleted.

0 comments on commit 7b2ba28

Please sign in to comment.