summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrank Dana <ferdnyc@gmail.com>2024-11-05 16:26:51 -0500
committerEli Schwartz <eschwartz93@gmail.com>2024-11-05 17:44:48 -0500
commit41dbfd93e455367993808a5975bc101231ccaa52 (patch)
tree7a157ff4c03cfde7982b2293b80162bc3146cdb9 /docs
parent6eb1a2726e15d4301b000b177e72e75263bdd499 (diff)
downloadmeson-41dbfd93e455367993808a5975bc101231ccaa52.tar.gz
Document hotdoc.generate_doc(depends:) kwarg
Document the results of commit bcc127b3f, which added 'depends' and deprecated using 'dependencies' for custom targets. Fixes: #11479
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Hotdoc-module.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/markdown/Hotdoc-module.md b/docs/markdown/Hotdoc-module.md
index d33dd3e7c..cf972ca35 100644
--- a/docs/markdown/Hotdoc-module.md
+++ b/docs/markdown/Hotdoc-module.md
@@ -33,12 +33,19 @@ Generates documentation using [hotdoc] and installs it into `$prefix/share/doc/h
* `sitemap` ([[@str]] or [[@file]]) (**required**): The hotdoc sitemap file
* `index` ([[@str]] or [[@file]]) (**required**): Location of the index file
-* `dependencies`([[@build_tgt]]): Targets on which the documentation generation depends on.
+* `dependencies`([[@build_tgt]]): Build targets to use when generating documentation.
+* `depends`([[@custom_tgt]]): Custom targets on which this documentation target depends.
* `subprojects`: A list of `HotdocTarget` that are used as subprojects for hotdoc to generate
the documentation.
* ... Any argument of `hotdoc` can be used replacing dashes (`-`) with underscores (`_`).
For a full list of available parameters, just have a look at `hotdoc help`.
+*Changed in 0.64.1:* `depends:` added.
+Previously, all types of targets were accepted by `dependencies:`.
+This is now deprecated.
+Use `dependencies:` only with build targets, to pass their configuration to hotdoc.
+Use `depends:` to set up dependency relationships on custom targets.
+
**Returns:**
`HotdocTarget`: A [[custom_target]] with the
@@ -72,4 +79,4 @@ hotdoc.generate_doc('foobar',
)
```
-[hotdoc]: https://hotdoc.github.io/ \ No newline at end of file
+[hotdoc]: https://hotdoc.github.io/