Skip to content

Commit

Permalink
Upgrade stardoc to 0.6.2
Browse files Browse the repository at this point in the history
Also declare it as a Bzlmod dev dependency, to fix Bazel last_green.

Signed-off-by: Brentley Jones <github@brentleyjones.com>
  • Loading branch information
brentleyjones committed Oct 17, 2023
1 parent c593eab commit 1a550c8
Show file tree
Hide file tree
Showing 14 changed files with 1,392 additions and 1,483 deletions.
7 changes: 7 additions & 0 deletions MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ bazel_dep(name = "bazel_skylib", version = "1.3.0")
bazel_dep(name = "platforms", version = "0.0.7")
bazel_dep(name = "rules_swift", version = "1.12.0", repo_name = "build_bazel_rules_swift")

bazel_dep(
name = "stardoc",
version = "0.6.2",
dev_dependency = True,
repo_name = "io_bazel_stardoc",
)

non_module_deps = use_extension("//apple:extensions.bzl", "non_module_deps")
use_repo(
non_module_deps,
Expand Down
28 changes: 25 additions & 3 deletions WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,29 @@ load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
name = "io_bazel_stardoc",
sha256 = "5e20c5b2a2d203131efdd9a7ba26e81f2a67fb2ed068b6c0d53766ba0611f9fe",
strip_prefix = "stardoc-97c0751114ad83b22877e05f3cbcda4ab5d77de5",
url = "https://github.com/bazelbuild/stardoc/archive/97c0751114ad83b22877e05f3cbcda4ab5d77de5.tar.gz",
sha256 = "62bd2e60216b7a6fec3ac79341aa201e0956477e7c8f6ccc286f279ad1d96432",
urls = [
"https://mirror.bazel.build/github.com/bazelbuild/stardoc/releases/download/0.6.2/stardoc-0.6.2.tar.gz",
"https://github.com/bazelbuild/stardoc/releases/download/0.6.2/stardoc-0.6.2.tar.gz",
],
)

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()
183 changes: 47 additions & 136 deletions doc/providers.md

Large diffs are not rendered by default.

252 changes: 133 additions & 119 deletions doc/rules-apple.md

Large diffs are not rendered by default.

13 changes: 6 additions & 7 deletions doc/rules-docc.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ docc_archive(<a href="#docc_archive-name">name</a>, <a href="#docc_archive-defau
<a href="#docc_archive-transform_for_static_hosting">transform_for_static_hosting</a>)
</pre>


Builds a .doccarchive for the given dependency.
The target created by this rule can also be `run` to preview the generated documentation in Xcode.

Expand All @@ -38,14 +37,14 @@ docc_archive(
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| <a id="docc_archive-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="docc_archive-default_code_listing_language"></a>default_code_listing_language | A fallback default language for code listings if no value is provided in the documentation bundle's Info.plist file. | String | optional | <code>""</code> |
| <a id="docc_archive-dep"></a>dep | - | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
| <a id="docc_archive-diagnostic_level"></a>diagnostic_level | Filters diagnostics above this level from output This filter level is inclusive. If a level of <code>information</code> is specified, diagnostics with a severity up to and including <code>information</code> will be printed. Must be one of "error", "warning", "information", or "hint" | String | optional | <code>""</code> |
| <a id="docc_archive-enable_inherited_docs"></a>enable_inherited_docs | Inherit documentation for inherited symbols. | Boolean | optional | <code>False</code> |
| <a id="docc_archive-default_code_listing_language"></a>default_code_listing_language | A fallback default language for code listings if no value is provided in the documentation bundle's Info.plist file. | String | optional | `""` |
| <a id="docc_archive-dep"></a>dep | - | <a href="https://bazel.build/concepts/labels">Label</a> | optional | `None` |
| <a id="docc_archive-diagnostic_level"></a>diagnostic_level | Filters diagnostics above this level from output This filter level is inclusive. If a level of `information` is specified, diagnostics with a severity up to and including `information` will be printed. Must be one of "error", "warning", "information", or "hint" | String | optional | `""` |
| <a id="docc_archive-enable_inherited_docs"></a>enable_inherited_docs | Inherit documentation for inherited symbols. | Boolean | optional | `False` |
| <a id="docc_archive-fallback_bundle_identifier"></a>fallback_bundle_identifier | A fallback bundle identifier if no value is provided in the documentation bundle's Info.plist file. | String | required | |
| <a id="docc_archive-fallback_bundle_version"></a>fallback_bundle_version | A fallback bundle version if no value is provided in the documentation bundle's Info.plist file. | String | required | |
| <a id="docc_archive-fallback_display_name"></a>fallback_display_name | A fallback display name if no value is provided in the documentation bundle's Info.plist file. | String | required | |
| <a id="docc_archive-kinds"></a>kinds | The kinds of entities to filter generated documentation for. | List of strings | optional | <code>[]</code> |
| <a id="docc_archive-transform_for_static_hosting"></a>transform_for_static_hosting | - | Boolean | optional | <code>True</code> |
| <a id="docc_archive-kinds"></a>kinds | The kinds of entities to filter generated documentation for. | List of strings | optional | `[]` |
| <a id="docc_archive-transform_for_static_hosting"></a>transform_for_static_hosting | - | Boolean | optional | `True` |


6 changes: 2 additions & 4 deletions doc/rules-dtrace.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
dtrace_compile(<a href="#dtrace_compile-name">name</a>, <a href="#dtrace_compile-srcs">srcs</a>)
</pre>


Compiles
[dtrace files with probes](https://www.ibm.com/developerworks/aix/library/au-dtraceprobes.html)
to generate header files to use those probes in C languages. The header files
Expand All @@ -24,15 +23,14 @@ structure. For example with a directory structure of
bar.d
```
and a target named `dtrace_gen` the header path would be
`&lt;GENFILES&gt;/dtrace_gen/foo/bar.h`.

`<GENFILES>/dtrace_gen/foo/bar.h`.

**ATTRIBUTES**


| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| <a id="dtrace_compile-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="dtrace_compile-srcs"></a>srcs | dtrace(.d) source files to be compiled. | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | <code>[]</code> |
| <a id="dtrace_compile-srcs"></a>srcs | dtrace(.d) source files to be compiled. | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | `[]` |


Loading

0 comments on commit 1a550c8

Please sign in to comment.