Skip to content

Commit d029a88

Browse files
committed
docs: add badge
1 parent f811361 commit d029a88

File tree

3 files changed

+6
-12
lines changed

3 files changed

+6
-12
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Doxygen rules for Bazel
22

3+
[![Bazel Central Repository](https://img.shields.io/badge/BCR-1.3.0-%230C713A?logo=bazel)](https://registry.bazel.build/modules/rules_doxygen)
34
[![CI](https://github.com/TendTo/rules_doxygen/actions/workflows/ci.yml/badge.svg)](https://github.com/TendTo/rules_doxygen/actions/workflows/ci.yml)
45

56
This repository contains a [Starlark](https://github.com/bazelbuild/starlark) implementation of [Doxygen](https://www.doxygen.nl/) rules in [Bazel](https://bazel.build/).
@@ -76,14 +77,13 @@ No download will be performed and bazel will use the installed version of doxyge
7677
> [!Warning]
7778
> Setting the version to `0.0.0` this will break the hermeticity of your build, as it will now depend on the environment.
7879
79-
The module also supports multiple versions of doxygen for different platforms.
80-
Each will only be downloaded if the given platform matches the current platform.
81-
8280
> [!Tip]
83-
> Not indicating the platform will make the configuration apply to all platforms.
81+
> Not indicating the platform will make the configuration apply to the platform it is running on.
8482
> The build will fail when the downloaded file does not match the SHA256 checksum, i.e. when the platform changes.
8583
> Unless you are using a system-wide doxygen installation, you should always specify the platform.
8684
85+
Different strategies can be combined in the same file, one for each platform, as shown below:
86+
8787
```bzl
8888
# MODULE.bazel file
8989

docs/extensions_doc.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,8 @@ No download will be performed and bazel will use the installed version of doxyge
114114
> [!Warning]
115115
> Setting the version to `0.0.0` this will break the hermeticity of your build, as it will now depend on the environment.
116116
117-
The module also supports multiple versions of doxygen for different platforms.
118-
Each will only be downloaded if the given platform matches the current platform.
119-
120117
> [!Tip]
121-
> Not indicating the platform will make the configuration apply to all platforms.
118+
> Not indicating the platform will make the configuration apply to the platform it is running on.
122119
> The build will fail when the downloaded file does not match the SHA256 checksum, i.e. when the platform changes.
123120
> Unless you are using a system-wide doxygen installation, you should always specify the platform.
124121

extensions.bzl

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -266,11 +266,8 @@ No download will be performed and bazel will use the installed version of doxyge
266266
> [!Warning]
267267
> Setting the version to `0.0.0` this will break the hermeticity of your build, as it will now depend on the environment.
268268
269-
The module also supports multiple versions of doxygen for different platforms.
270-
Each will only be downloaded if the given platform matches the current platform.
271-
272269
> [!Tip]
273-
> Not indicating the platform will make the configuration apply to all platforms.
270+
> Not indicating the platform will make the configuration apply to the platform it is running on.
274271
> The build will fail when the downloaded file does not match the SHA256 checksum, i.e. when the platform changes.
275272
> Unless you are using a system-wide doxygen installation, you should always specify the platform.
276273

0 commit comments

Comments
 (0)