forked from lix-project/lix
This doesn't comprehensively fix everything outdated in the manual, or
make the manual greatly better, but it does note down where at least
jade noticed it was wrong, and it does fix all the instances of
referencing Nix to conform to the style guide to the best of our
ability.
A lot of things have been commented out for being wrong, and there are
three types of FIXME introduced:
- FIXME(Lix): generically Lix needs to fix it
- FIXME(Qyriad): re lix-project/lix#215
- FIXME(meson): docs got outdated by meson changes and need rewriting
I did fix a bunch of it that I could, but there could certainly be
mistakes and this is definitely just an incremental improvement.
Fixes: lix-project/lix#266
Change-Id: I5993c4603d7f026a887089fce77db08394362135
39 lines
1.4 KiB
TOML
39 lines
1.4 KiB
TOML
[book]
|
|
title = "Lix Reference Manual"
|
|
|
|
[build]
|
|
create-missing = false
|
|
|
|
[output.html]
|
|
additional-css = ["custom.css"]
|
|
additional-js = ["redirects.js"]
|
|
# Using our GitHub mirror enables easier typo fixes since there is no easy way
|
|
# to just submit a Gerrit CL by the web for trivial stuff.
|
|
edit-url-template = "https://github.com/lix-project/lix/tree/main/doc/manual/{path}"
|
|
git-repository-url = "https://git.lix.systems/lix-project/lix"
|
|
|
|
# Handles replacing @docroot@ with a path to ./src relative to that markdown file,
|
|
# {{#include handlebars}}, and the @generated@ syntax used within these. it mostly
|
|
# but not entirely replaces the links preprocessor (which we cannot simply use due
|
|
# to @generated@ files living in a different directory to make meson happy). we do
|
|
# not want to disable the links preprocessor entirely though because that requires
|
|
# disabling *all* built-in preprocessors and selectively reenabling those we want.
|
|
[preprocessor.substitute]
|
|
command = "python3 doc/manual/substitute.py"
|
|
before = ["anchors", "links"]
|
|
|
|
[preprocessor.anchors]
|
|
renderers = ["html"]
|
|
command = "jq --from-file doc/manual/anchors.jq"
|
|
|
|
[output.markdown]
|
|
|
|
[output.linkcheck]
|
|
# no Internet during the build (in the sandbox)
|
|
follow-web-links = false
|
|
|
|
# mdbook-linkcheck does not understand [foo]{#bar} style links, resulting in
|
|
# excessive "Potential incomplete link" warnings. No other kind of warning was
|
|
# produced at the time of writing.
|
|
warning-policy = "ignore"
|