Stardoc com

After the io_bazel_stardoc repository definition ensures that this repository's dependencies are loaded (each function call defines additional repositories for Stardoc's dependencies, which are then used by subsequent load statements).Note that WORKSPACE files are sensitive to the order of dependencies. If, after updating to a newer version of Stardoc, you encounter "not a valid maven_install.json file" or other repository fetch errors (example: #186), try moving the Stardoc dependency block above or below other dependencies in your WORKSPACE file.Using the rulesSee the source. 0.7.1 Release 0.7.1Notable ChangesReally fix building with --incompatible_disallow_empty_glob (#238).Auxiliary rule targets created by stardoc() macro now include provided tags (#247)ContributorsAlexandre Rostovtsev, Lukács Berki, yashathwaniMODULE.bazel setupbazel_dep(name = "stardoc", version = "0.7.1")By default - in other words, when using Bzlmod for dependency management - Stardoc uses @stardoc as its repo name. The legacy WORSKSPACE setup (see below) used @io_bazel_stardoc instead. For compatibility with the legacy WORKSPACE setup, you may add repo_name = "io_bazel_stardoc" to the bazel_dep call.Legacy WORKSPACE setupTo use Stardoc, add the following to your WORKSPACE file:load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")http_archive( name = "io_bazel_stardoc", sha256 = "fabb280f6c92a3b55eed89a918ca91e39fb733373c81e87a18ae9e33e75023ec", urls = [ " " ],)load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")stardoc_repositories()load("@rules_jvm_external//:repositories.bzl", "rules_jvm_external_deps")rules_jvm_external_deps()load("@rules_jvm_external//:setup.bzl", "rules_jvm_external_setup")rules_jvm_external_setup()load("@io_bazel_stardoc//:deps.bzl", "stardoc_external_deps")stardoc_external_deps()load("@stardoc_maven//:defs.bzl", stardoc_pinned_maven_install = "pinned_maven_install")stardoc_pinned_maven_install()The sequence of function calls and load statements after the io_bazel_stardoc repository definition ensures that this repository's dependencies are loaded (each function call defines additional repositories for Stardoc's dependencies, which are then used by subsequent load statements).Note that WORKSPACE files are sensitive to the order of dependencies. If, after updating to a newer version of Stardoc, you encounter "not a valid maven_install.json file" or other repository fetch errors (example: #186), try moving the Stardoc dependency block above or below other dependencies in your WORKSPACE file.Using the rulesSee the source. 0.7.0 Release 0.7.0This release requires Bazel 7 or newer.By default - when using Bzlmod for dependency management - Stardoc now uses @stardoc as its repo name.For compatibility with the legacy WORKSPACE-based setup (which used @io_bazel_stardoc as the repo name) and ease of migration, you may load Stardoc viabazel_dep(name = "stardoc", repo_name = "io_bazel_stardoc", ...)in your MODULE.bazel file.New FeaturesAdd support for a table of contents template (#203). This is disabled by default, but Stardoc comes with

An example template that you can use. To enable, set table_of_contents_template, for example:stardoc( ..., table_of_contents_template = "@stardoc//stardoc:templates/markdown_tables/table_of_contents.vm",)Add support for a footer template (#206). This is disabled by default; to enable, set footer_template to a .vm file, which you will need to provide.Add support for providing stamping to Stardoc templates (#205). To use, use $util.formatBuildTimestamp and $stamping in a template file (footer_template - see above - is recommended for this); for example:Built on `$util.formatBuildTimestamp($stamping.volatile.BUILD_TIMESTAMP, "UTC", "yyyy-MM-dd HH:mm")`Render documentation for provider init callbacks (#224)Properly render *args, *, and **kwargs in summaries (#231). This requires Bazel 8 (prerelease 20240603 or newer).Include load statement in summaries (#216)Incompatible ChangesThe legacy extractor has been removed (#212). Stardoc always uses the starlark_doc_extract-based extractor. The stardoc, semantic_flags, and use_starlark_doc_extract arguments to stardoc() macro have been removed.Stardoc uses Bzlmod by default for dependency management (#213). This means that by default, Stardoc now uses @stardoc as its repo name.ContributorsAlex Humesky, Alexandre Rostovtsev, Fabian Meumertzheim, Grzegorz Lukasik, Xùdōng Yáng, Yun PengMODULE.bazel setupbazel_dep(name = "stardoc", version = "0.7.0")By default - in other words, when using Bzlmod for dependency management - Stardoc uses @stardoc as its repo name. The legacy WORSKSPACE setup (see below) used @io_bazel_stardoc instead. For compatibility with the legacy WORKSPACE setup, you may add repo_name = "io_bazel_stardoc" to the bazel_dep call.Legacy WORKSPACE setupTo use Stardoc, add the following to your WORKSPACE file:load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")http_archive( name = "io_bazel_stardoc", sha256 = "dd7f32f4fe2537ce2452c51f816a5962d48888a5b07de2c195f3b3da86c545d3", urls = [ " " ],)load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")stardoc_repositories()load("@rules_jvm_external//:repositories.bzl", "rules_jvm_external_deps")rules_jvm_external_deps()load("@rules_jvm_external//:setup.bzl", "rules_jvm_external_setup")rules_jvm_external_setup()load("@io_bazel_stardoc//:deps.bzl", "stardoc_external_deps")stardoc_external_deps()load("@stardoc_maven//:defs.bzl", stardoc_pinned_maven_install = "pinned_maven_install")stardoc_pinned_maven_install()The sequence of function calls and load statements after the io_bazel_stardoc repository definition ensures that this repository's dependencies are loaded (each function call defines additional repositories for Stardoc's dependencies, which are then used by subsequent load statements).Note that WORKSPACE files are sensitive to the order of dependencies. If, after updating to a newer version of Stardoc, you encounter "not a valid maven_install.json file" or other repository fetch errors (example: #186), try moving the Stardoc dependency block above or below other dependencies in your WORKSPACE file.Using the rulesSee the source. 0.6.2 Release 0.6.2Bugfix release: bumps rules_jvm_external dependency to support building with --incompatible_disable_starlark_host_transitionsContributorsAlexandre RostovtsevWORKSPACE setupTo use Stardoc, add the following to

0.8.0 Release 0.8.0New FeaturesAdds support for documenting symbolic macros when using Bazel 8.0.1 or newer. (Note that the original Bazel 8.0.0 release had a bug causing macro documentation emitted by Stardoc to be be incomplete.) (#267)ContributorsAlexandre Rostovtsev, Keith Smiley, Richard LevasseurMODULE.bazel setupbazel_dep(name = "stardoc", version = "0.8.0")By default - in other words, when using Bzlmod for dependency management - Stardoc uses @stardoc as its repo name. The legacy WORSKSPACE setup (see below) used @io_bazel_stardoc instead. For compatibility with the legacy WORKSPACE setup, you may add repo_name = "io_bazel_stardoc" to the bazel_dep call.Legacy WORKSPACE setupTo use Stardoc, add the following to your WORKSPACE file:load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")http_archive( name = "io_bazel_stardoc", sha256 = "ca933f39f2a6e0ad392fa91fd662545afcbd36c05c62365538385d35a0323096", urls = [ " " ],)load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")stardoc_repositories()load("@rules_java//java:rules_java_deps.bzl", "rules_java_dependencies")rules_java_dependencies()load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")protobuf_deps()load("@rules_jvm_external//:repositories.bzl", "rules_jvm_external_deps")rules_jvm_external_deps()load("@rules_jvm_external//:setup.bzl", "rules_jvm_external_setup")rules_jvm_external_setup()load("@io_bazel_stardoc//:deps.bzl", "stardoc_external_deps")stardoc_external_deps()load("@stardoc_maven//:defs.bzl", stardoc_pinned_maven_install = "pinned_maven_install")stardoc_pinned_maven_install()The sequence of function calls and load statements after the io_bazel_stardoc repository definition ensures that this repository's dependencies are loaded (each function call defines additional repositories for Stardoc's dependencies, which are then used by subsequent load statements).Note that WORKSPACE files are sensitive to the order of dependencies. If, after updating to a newer version of Stardoc, you encounter "not a valid maven_install.json file" or other repository fetch errors (example: #186), try moving the Stardoc dependency block above or below other dependencies in your WORKSPACE file.Using the rulesSee the source. 0.7.2 Release 0.7.2Bugfix release: fixes compatibility issues with Bazel 7.4 and 8.0.Note that this release breaks compatibility with g++ 7.5 (the default compiler in the Ubuntu 18.04 image) - a new transitive dep requires a newer c++ compiler version.ContributorsAlexandre Rostovtsev, Hemanshu Vadehra, Philip Zembrod, Richard LevasseurMODULE.bazel setupbazel_dep(name = "stardoc", version = "0.7.2")By default - in other words, when using Bzlmod for dependency management - Stardoc uses @stardoc as its repo name. The legacy WORSKSPACE setup (see below) used @io_bazel_stardoc instead. For compatibility with the legacy WORKSPACE setup, you may add repo_name = "io_bazel_stardoc" to the bazel_dep call.Legacy WORKSPACE setupTo use Stardoc, add the following to your WORKSPACE file:load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")http_archive( name = "io_bazel_stardoc", sha256 = "0e1ed4a98f26e718776bd64d053d02bb34d98572ccd03d6ba355112a1205706b", urls = [ " " ],)load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")stardoc_repositories()load("@rules_java//java:rules_java_deps.bzl", "rules_java_dependencies")rules_java_dependencies()load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")protobuf_deps()load("@rules_jvm_external//:repositories.bzl", "rules_jvm_external_deps")rules_jvm_external_deps()load("@rules_jvm_external//:setup.bzl", "rules_jvm_external_setup")rules_jvm_external_setup()load("@io_bazel_stardoc//:deps.bzl", "stardoc_external_deps")stardoc_external_deps()load("@stardoc_maven//:defs.bzl", stardoc_pinned_maven_install = "pinned_maven_install")stardoc_pinned_maven_install()The sequence of function calls and load statements

Your WORKSPACE file:load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")http_archive( name = "io_bazel_stardoc", sha256 = "62bd2e60216b7a6fec3ac79341aa201e0956477e7c8f6ccc286f279ad1d96432", urls = [ " " ],)load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")stardoc_repositories()load("@rules_jvm_external//:repositories.bzl", "rules_jvm_external_deps")rules_jvm_external_deps()load("@rules_jvm_external//:setup.bzl", "rules_jvm_external_setup")rules_jvm_external_setup()load("@io_bazel_stardoc//:deps.bzl", "stardoc_external_deps")stardoc_external_deps()load("@stardoc_maven//:defs.bzl", stardoc_pinned_maven_install = "pinned_maven_install")stardoc_pinned_maven_install()The sequence of function calls and load statements after the io_bazel_stardoc repository definition ensures that this repository's dependencies are loaded (each function call defines additional repositories for Stardoc's dependencies, which are then used by subsequent load statements).Note that WORKSPACE files are sensitive to the order of dependencies. If, after updating to a newer version of Stardoc, you encounter "not a valid maven_install.json file" or other repository fetch errors (example: #186), try moving the Stardoc dependency block above or below other dependencies in your WORKSPACE file.MODULE.bazel setupbazel_dep(name = "stardoc", version = "0.6.2")For compatibility with WORKSPACE setup, add repo_name = "io_bazel_stardoc" to the bazel_dep call.Using the rulesSee the source. 0.6.1 Release 0.6.1Bugfix release: fix rules_jvm_external pin warnings.This release temporarily restores compatibility with Bazel 5 (manually tested). Note that normally we only test Stardoc with the current stable Bazel and with Bazel at HEAD - not with older releases. We make no promises about maintaining compatibility with Bazel 5.ContributorsAlexandre RostovtsevWORKSPACE setupTo use Stardoc, add the following to your WORKSPACE file:load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")http_archive( name = "io_bazel_stardoc", sha256 = "3082a199f39e1fd9ed608421516fdbe9e9af8eb34f52e46e9a8c4798c8e6bfad", urls = [ " " ],)load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")stardoc_repositories()load("@rules_jvm_external//:repositories.bzl", "rules_jvm_external_deps")rules_jvm_external_deps()load("@rules_jvm_external//:setup.bzl", "rules_jvm_external_setup")rules_jvm_external_setup()load("@io_bazel_stardoc//:deps.bzl", "stardoc_external_deps")stardoc_external_deps()load("@stardoc_maven//:defs.bzl", stardoc_pinned_maven_install = "pinned_maven_install")stardoc_pinned_maven_install()MODULE.bazel setupbazel_dep(name = "stardoc", version = "0.6.1")For compatibility with WORKSPACE setup, add repo_name = "io_bazel_stardoc" to the bazel_dep call.Using the rulesSee the source. 0.6.0 Release 0.6.0New FeaturesStardoc no longer escapes HTML tags in documentation. Feel free to use HTML formatting in your docs! We now also have much-improved rendering for fenced code blocks in attribute docs, and render attribute default values using Markdown instead of HTML markup. (#161, #167)Stardoc now dedents and trims all doc strings - not only in macros (#170). This means you can havemy_rule = rule( doc = """ This is my rule. Here is more info about it. ... """, ...)and Stardoc will dedent and trim the doc toThis is my rule.Here is more info about it....When using Bazel 7 or newer (or current Bazel HEAD), Stardoc will by default use the native starlark_doc_extract rule internally (#166).This means,