10d6d2860c
docs: mention additional python modules needed for building
...
Also check that they are available in meson.build.
Closes #11772
2023-05-09 21:33:33 -04:00
53f43605ce
docs: make the man page installable
...
Users now have the *option* to run the documentation build and use
`meson install` to install man pages.
2023-05-09 21:33:32 -04:00
6f78db93bf
docs: add option to skip building HTML docs
...
Reorder meson targets to handle those all at the end, and exit early if
HTML documentation is disabled. This makes it possible to build just the
manpage, without hotdoc installed.
2023-05-09 21:33:32 -04:00
740d926eee
docs: add meson option to use the unsafe loader
2023-05-09 19:48:42 -04:00
9de07ff4d7
Enable fatal warnings in HotDoc when building website.
2023-05-09 18:36:25 -04:00
c88c1e7dba
doc: Generate dev release notes
2022-05-24 20:19:46 +03:00
19de032d20
docs: make upload target depend on building the docs
...
Manually running hotdoc's upload command does not guarantee the docs
have actually been built.
2022-04-14 18:37:04 -04:00
71ea9e3d4c
add man page generation to build
2022-01-06 20:14:34 -06:00
89e9b50292
doc: Requires hotdoc >=0.13.7
...
Building documentation fails with older hotdoc versions.
2021-10-26 18:02:09 +02:00
2ab5620769
docs: GitHub Action up the JSON docs
2021-10-09 23:07:21 +02:00
a8189d0c70
docs: Temporarily disable modules and move RefMan --> Reference-manual
2021-10-04 23:11:48 +02:00
5dd8171fb3
docs: Use a custom hotdoc extension for links to RefMan
2021-10-03 12:19:45 +02:00
7cfe7ccc58
docs: Hook up the new RefMan generator to Meson
2021-10-03 11:46:34 +02:00
4516b7a8a9
docs: Fix typo in github pages repo URL
2021-06-02 10:55:43 -04:00
4dec7dbb71
ci: Automatically update website when pushing to master
2021-06-02 17:39:34 +03:00
c18a9715b8
Hotdoc: use template for Commands.md instead of generating the entire file ( #8154 )
...
* doc: fix hotdoc misuse for dynamically generated content
hotdoc has a native include feature for including files inline. Use this
to generate one file for each dynamically generated code block, and
include that file in Commands.md; see:
https://hotdoc.github.io/syntax-extensions.html#smart-file-inclusion-syntax
This permits us to move back to using the in-tree version of the hotdoc
*.md sources, thus fixing the incorrect inclusion of "builddir/" in the
"Edit on github" links which resulted from using copies as the source.
Fixes #8061
* doc: call the dummy file a "stamp" as it is a better known term
2021-01-10 14:48:34 +02:00
b3c869918b
docs: fix "edit on GitHub" links
2020-12-10 00:26:28 +02:00
b6981bd16e
Made Commands.md dynamically generated ( #7346 )
2020-06-30 23:56:08 +03:00
4631dbfc27
Upgrade to newest hotdoc. [skip ci]
2018-09-13 21:22:30 +03:00
6f72473b24
docs: Use meson to build documentation
...
Let's eat our own dogfood.
2018-08-28 18:18:40 -03:00
Eli Schwartz