Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Nov 5, 2024
1 parent 5db05b4 commit 5e3fb76
Show file tree
Hide file tree
Showing 22 changed files with 28 additions and 20 deletions.
9 changes: 8 additions & 1 deletion Hotdoc-module.html
Original file line number Diff line number Diff line change
Expand Up @@ -233,13 +233,20 @@ <h3 id="hotdocgenerate_doc">hotdoc.generate_doc()</h3>
<li>
<code>index</code> (<a href="Reference-manual_elementary_str.html"><ins><code>str</code></ins></a> or <a href="Reference-manual_returned_file.html"><ins><code>file</code></ins></a>) (<strong>required</strong>): Location of the index file</li>
<li>
<code>dependencies</code>(<a href="Reference-manual_returned_build_tgt.html"><ins><code>build_tgt</code></ins></a>): Targets on which the documentation generation depends on.</li>
<code>dependencies</code>(<a href="Reference-manual_returned_build_tgt.html"><ins><code>build_tgt</code></ins></a>): Build targets to use when generating documentation.</li>
<li>
<code>depends</code>(<a href="Reference-manual_returned_custom_tgt.html"><ins><code>custom_tgt</code></ins></a>): Custom targets on which this documentation target depends.</li>
<li>
<code>subprojects</code>: A list of <code>HotdocTarget</code> that are used as subprojects for hotdoc to generate
the documentation.</li>
<li>... Any argument of <code>hotdoc</code> can be used replacing dashes (<code>-</code>) with underscores (<code>_</code>).
For a full list of available parameters, just have a look at <code>hotdoc help</code>.</li>
</ul>
<p><em>Changed in 0.64.1:</em> <code>depends:</code> added.
Previously, all types of targets were accepted by <code>dependencies:</code>.
This is now deprecated.
Use <code>dependencies:</code> only with build targets, to pass their configuration to hotdoc.
Use <code>depends:</code> to set up dependency relationships on custom targets.</p>
<p><strong>Returns:</strong></p>
<p><code>HotdocTarget</code>: A <a href="Reference-manual_functions.html#custom_target"><ins><code>custom_target()</code></ins></a> with the
following extra methods:</p>
Expand Down
2 changes: 1 addition & 1 deletion assets/js/search/Build
Original file line number Diff line number Diff line change
@@ -1 +1 @@
urls_downloaded_cb({"token":"Build","urls":[{"url":"Build-options.html#build-option-types","node_type":"h2","page":"Build options","sections":["Build options","Build option types"],"context":{"gi-language":["default"]}},{"url":"Build-options.html#build-options","node_type":"h1","page":"Build options","sections":["Build options"],"context":{"gi-language":["default"]}},{"url":"Build-system-converters.html#build-system-converters","node_type":"h1","page":"Build system converters","sections":["Build system converters"],"context":{"gi-language":["default"]}},{"url":"Build-targets.html#build-targets","node_type":"h1","page":"Build targets","sections":["Build targets"],"context":{"gi-language":["default"]}},{"url":"Builtin-options.html#base-options","node_type":"table","page":"Built-in options","sections":["Built-in options","Base options"],"context":{"gi-language":["default"]}},{"url":"Builtin-options.html#core-options","node_type":"table","page":"Built-in options","sections":["Built-in options","Universal options","Core options"],"context":{"gi-language":["default"]}},{"url":"Commands.html#examples1","node_type":"p","page":"Command-line commands","sections":["Command-line commands","compile","Examples:"],"context":{"gi-language":["default"]}},{"url":"Continuous-Integration.html#qt","node_type":"p","page":"Continuous Integration","sections":["Continuous Integration","AppVeyor for Windows","Qt"],"context":{"gi-language":["default"]}},{"url":"FAQ.html#why-doesnt-meson-have-user-defined-functionsmacros","node_type":"p","page":"FAQ","sections":["Meson Frequently Asked Questions","Why doesn't meson have user defined functions/macros?"],"context":{"gi-language":["default"]}},{"url":"IDE-integration.html#build-options","node_type":"h2","page":"IDE integration","sections":["IDE integration","Build Options"],"context":{"gi-language":["default"]}},{"url":"IDE-integration.html#build-system-files","node_type":"h2","page":"IDE integration","sections":["IDE integration","Build system files"],"context":{"gi-language":["default"]}},{"url":"Installing.html#installing","node_type":"p","page":"Installing","sections":["Installing"],"context":{"gi-language":["default"]}},{"url":"Manual.html#subpages","node_type":"p","page":"Manual","sections":[],"context":{"gi-language":["default"]}},{"url":"Project-templates.html#build-after-generation-of-template","node_type":"h1","page":"Project templates","sections":["Build after generation of template"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_builtin.html#subpages","node_type":"p","page":"Builtin objects","sections":[],"context":{"gi-language":["default"]}},{"url":"Reference-manual_builtin_build_machine.html#build-machine-information-build_machine","node_type":"h1","page":"build_machine","sections":["Build machine information (build_machine)"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_builtin_build_machine.html#build-machine-information-methods","node_type":"h2","page":"build_machine","sections":["Build machine information (build_machine)","Build machine information methods"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_builtin_build_machine.html#extended-by","node_type":"p","page":"build_machine","sections":["Build machine information (build_machine)","Extended by"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_builtin_meson.html#mesonbuild_options","node_type":"p","page":"meson","sections":["Meson object (meson)","Meson object methods","meson.build_options()"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_functions.html#arguments11","node_type":"table","page":"Functions","sections":["Functions","build_target()","Arguments"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_functions.html#arguments20","node_type":"table","page":"Functions","sections":["Functions","executable()","Arguments"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_functions.html#build_target_pie","node_type":"p","page":"Functions","sections":["Functions","build_target()","Arguments"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_functions.html#executable_pie","node_type":"p","page":"Functions","sections":["Functions","executable()","Arguments"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_functions.html#jar","node_type":"p","page":"Functions","sections":["Functions","jar()"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_returned.html#subpages","node_type":"p","page":"Returned objects","sections":[],"context":{"gi-language":["default"]}},{"url":"Reference-manual_returned_build_tgt.html#build-target-build_tgt-extends-tgt","node_type":"h1","page":"Build target","sections":["Build target (build_tgt extends tgt)"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_returned_build_tgt.html#build-target-methods","node_type":"h2","page":"Build target","sections":["Build target (build_tgt extends tgt)","Build target methods"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_returned_build_tgt.html#extended-by","node_type":"p","page":"Build target","sections":["Build target (build_tgt extends tgt)","Extended by"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_returned_build_tgt.html#returned-by","node_type":"p","page":"Build target","sections":["Build target (build_tgt extends tgt)","Returned by"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-38-0.html#set-targets-to-be-built-or-not-by-default","node_type":"p","page":"Release 0.38","sections":["Set targets to be built (or not) by default"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-40-0.html#overriding-options-per-target","node_type":"p","page":"Release 0.40","sections":["New features","Overriding options per target"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-46-0.html#test-now-supports-the-depends-keyword-argument","node_type":"p","page":"Release 0.46","sections":["New features","test() now supports the depends: keyword argument"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-48-0.html#keyword-argument-for-gnu-symbol-visibility","node_type":"p","page":"Release 0.48","sections":["New features","Keyword argument for GNU symbol visibility"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-54-0.html#added-name-method","node_type":"p","page":"Release 0.54.0","sections":["New features","Added 'name' method"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-58-0.html#summary-accepts-features","node_type":"p","page":"Release 0.58.0","sections":["New features","\nsummary() accepts features"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-1-5-0.html#meson-now-propagates-its-build-type-to-cmake","node_type":"p","page":"Release 1.5.0","sections":["New features","Meson now propagates its build type to CMake"],"context":{"gi-language":["default"]}},{"url":"Simple-comparison.html#a-simple-comparison","node_type":"p","page":"A simple comparison","sections":["A simple comparison"],"context":{"gi-language":["default"]}},{"url":"Simple-comparison.html#conclusions","node_type":"p","page":"A simple comparison","sections":["A simple comparison","Conclusions"],"context":{"gi-language":["default"]}},{"url":"Subprojects.html#build-options-in-subproject","node_type":"h3","page":"Subprojects","sections":["Subprojects","A subproject example","Build options in subproject"],"context":{"gi-language":["default"]}},{"url":"Videos.html#videos","node_type":"ul","page":"Videos","sections":["Videos"],"context":{"gi-language":["default"]}},{"url":"index.html#the-meson-build-system","node_type":"h1","page":"The Meson Build system","sections":["The Meson Build system"],"context":{"gi-language":["default"]}}]});
urls_downloaded_cb({"token":"Build","urls":[{"url":"Build-options.html#build-option-types","node_type":"h2","page":"Build options","sections":["Build options","Build option types"],"context":{"gi-language":["default"]}},{"url":"Build-options.html#build-options","node_type":"h1","page":"Build options","sections":["Build options"],"context":{"gi-language":["default"]}},{"url":"Build-system-converters.html#build-system-converters","node_type":"h1","page":"Build system converters","sections":["Build system converters"],"context":{"gi-language":["default"]}},{"url":"Build-targets.html#build-targets","node_type":"h1","page":"Build targets","sections":["Build targets"],"context":{"gi-language":["default"]}},{"url":"Builtin-options.html#base-options","node_type":"table","page":"Built-in options","sections":["Built-in options","Base options"],"context":{"gi-language":["default"]}},{"url":"Builtin-options.html#core-options","node_type":"table","page":"Built-in options","sections":["Built-in options","Universal options","Core options"],"context":{"gi-language":["default"]}},{"url":"Commands.html#examples1","node_type":"p","page":"Command-line commands","sections":["Command-line commands","compile","Examples:"],"context":{"gi-language":["default"]}},{"url":"Continuous-Integration.html#qt","node_type":"p","page":"Continuous Integration","sections":["Continuous Integration","AppVeyor for Windows","Qt"],"context":{"gi-language":["default"]}},{"url":"FAQ.html#why-doesnt-meson-have-user-defined-functionsmacros","node_type":"p","page":"FAQ","sections":["Meson Frequently Asked Questions","Why doesn't meson have user defined functions/macros?"],"context":{"gi-language":["default"]}},{"url":"Hotdoc-module.html#hotdocgenerate_doc","node_type":"ul","page":"Hotdoc module","sections":["Hotdoc module","Usage","hotdoc.generate_doc()"],"context":{"gi-language":["default"]}},{"url":"IDE-integration.html#build-options","node_type":"h2","page":"IDE integration","sections":["IDE integration","Build Options"],"context":{"gi-language":["default"]}},{"url":"IDE-integration.html#build-system-files","node_type":"h2","page":"IDE integration","sections":["IDE integration","Build system files"],"context":{"gi-language":["default"]}},{"url":"Installing.html#installing","node_type":"p","page":"Installing","sections":["Installing"],"context":{"gi-language":["default"]}},{"url":"Manual.html#subpages","node_type":"p","page":"Manual","sections":[],"context":{"gi-language":["default"]}},{"url":"Project-templates.html#build-after-generation-of-template","node_type":"h1","page":"Project templates","sections":["Build after generation of template"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_builtin.html#subpages","node_type":"p","page":"Builtin objects","sections":[],"context":{"gi-language":["default"]}},{"url":"Reference-manual_builtin_build_machine.html#build-machine-information-build_machine","node_type":"h1","page":"build_machine","sections":["Build machine information (build_machine)"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_builtin_build_machine.html#build-machine-information-methods","node_type":"h2","page":"build_machine","sections":["Build machine information (build_machine)","Build machine information methods"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_builtin_build_machine.html#extended-by","node_type":"p","page":"build_machine","sections":["Build machine information (build_machine)","Extended by"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_builtin_meson.html#mesonbuild_options","node_type":"p","page":"meson","sections":["Meson object (meson)","Meson object methods","meson.build_options()"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_functions.html#arguments11","node_type":"table","page":"Functions","sections":["Functions","build_target()","Arguments"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_functions.html#arguments20","node_type":"table","page":"Functions","sections":["Functions","executable()","Arguments"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_functions.html#build_target_pie","node_type":"p","page":"Functions","sections":["Functions","build_target()","Arguments"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_functions.html#executable_pie","node_type":"p","page":"Functions","sections":["Functions","executable()","Arguments"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_functions.html#jar","node_type":"p","page":"Functions","sections":["Functions","jar()"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_returned.html#subpages","node_type":"p","page":"Returned objects","sections":[],"context":{"gi-language":["default"]}},{"url":"Reference-manual_returned_build_tgt.html#build-target-build_tgt-extends-tgt","node_type":"h1","page":"Build target","sections":["Build target (build_tgt extends tgt)"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_returned_build_tgt.html#build-target-methods","node_type":"h2","page":"Build target","sections":["Build target (build_tgt extends tgt)","Build target methods"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_returned_build_tgt.html#extended-by","node_type":"p","page":"Build target","sections":["Build target (build_tgt extends tgt)","Extended by"],"context":{"gi-language":["default"]}},{"url":"Reference-manual_returned_build_tgt.html#returned-by","node_type":"p","page":"Build target","sections":["Build target (build_tgt extends tgt)","Returned by"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-38-0.html#set-targets-to-be-built-or-not-by-default","node_type":"p","page":"Release 0.38","sections":["Set targets to be built (or not) by default"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-40-0.html#overriding-options-per-target","node_type":"p","page":"Release 0.40","sections":["New features","Overriding options per target"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-46-0.html#test-now-supports-the-depends-keyword-argument","node_type":"p","page":"Release 0.46","sections":["New features","test() now supports the depends: keyword argument"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-48-0.html#keyword-argument-for-gnu-symbol-visibility","node_type":"p","page":"Release 0.48","sections":["New features","Keyword argument for GNU symbol visibility"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-54-0.html#added-name-method","node_type":"p","page":"Release 0.54.0","sections":["New features","Added 'name' method"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-58-0.html#summary-accepts-features","node_type":"p","page":"Release 0.58.0","sections":["New features","\nsummary() accepts features"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-1-5-0.html#meson-now-propagates-its-build-type-to-cmake","node_type":"p","page":"Release 1.5.0","sections":["New features","Meson now propagates its build type to CMake"],"context":{"gi-language":["default"]}},{"url":"Simple-comparison.html#a-simple-comparison","node_type":"p","page":"A simple comparison","sections":["A simple comparison"],"context":{"gi-language":["default"]}},{"url":"Simple-comparison.html#conclusions","node_type":"p","page":"A simple comparison","sections":["A simple comparison","Conclusions"],"context":{"gi-language":["default"]}},{"url":"Subprojects.html#build-options-in-subproject","node_type":"h3","page":"Subprojects","sections":["Subprojects","A subproject example","Build options in subproject"],"context":{"gi-language":["default"]}},{"url":"Videos.html#videos","node_type":"ul","page":"Videos","sections":["Videos"],"context":{"gi-language":["default"]}},{"url":"index.html#the-meson-build-system","node_type":"h1","page":"The Meson Build system","sections":["The Meson Build system"],"context":{"gi-language":["default"]}}]});
2 changes: 1 addition & 1 deletion assets/js/search/Changed
Original file line number Diff line number Diff line change
@@ -1 +1 @@
urls_downloaded_cb({"token":"Changed","urls":[{"url":"Machine-files.html#cross-and-native-file-reference","node_type":"p","page":"Cross and Native File reference","sections":["Cross and Native File reference"],"context":{"gi-language":["default"]}},{"url":"Machine-files.html#properties","node_type":"p","page":"Cross and Native File reference","sections":["Cross and Native File reference","Sections","Properties"],"context":{"gi-language":["default"]}},{"url":"Reference-tables.html#gcc-__attribute__","node_type":"p","page":"Reference tables","sections":["Reference tables","Function Attributes","GCC __attribute__\n"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-50-0.html#changed-the-json-format-of-the-introspection","node_type":"h2","page":"Release 0.50.0","sections":["New features","Changed the JSON format of the introspection"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-54-0.html#changed-the-signal-used-to-terminate-a-test-process-group","node_type":"h2","page":"Release 0.54.0","sections":["New features","Changed the signal used to terminate a test process (group)"],"context":{"gi-language":["default"]}}]});
urls_downloaded_cb({"token":"Changed","urls":[{"url":"Hotdoc-module.html#hotdocgenerate_doc","node_type":"p","page":"Hotdoc module","sections":["Hotdoc module","Usage","hotdoc.generate_doc()"],"context":{"gi-language":["default"]}},{"url":"Machine-files.html#cross-and-native-file-reference","node_type":"p","page":"Cross and Native File reference","sections":["Cross and Native File reference"],"context":{"gi-language":["default"]}},{"url":"Machine-files.html#properties","node_type":"p","page":"Cross and Native File reference","sections":["Cross and Native File reference","Sections","Properties"],"context":{"gi-language":["default"]}},{"url":"Reference-tables.html#gcc-__attribute__","node_type":"p","page":"Reference tables","sections":["Reference tables","Function Attributes","GCC __attribute__\n"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-50-0.html#changed-the-json-format-of-the-introspection","node_type":"h2","page":"Release 0.50.0","sections":["New features","Changed the JSON format of the introspection"],"context":{"gi-language":["default"]}},{"url":"Release-notes-for-0-54-0.html#changed-the-signal-used-to-terminate-a-test-process-group","node_type":"h2","page":"Release 0.54.0","sections":["New features","Changed the signal used to terminate a test process (group)"],"context":{"gi-language":["default"]}}]});
Loading

0 comments on commit 5e3fb76

Please sign in to comment.