treefmt: improve how doc-comments render in the manual
1. Use internal links for other manual sections 2. Fix definition-list syntax Currently, `:doc` doesn't support rendering clickable links anyway, so we don't loose much by having relative links.
This commit is contained in:
committed by
Valentin Gagarin
parent
4c638c2735
commit
6e5c68be85
@@ -15,9 +15,8 @@
|
||||
|
||||
# Inputs
|
||||
|
||||
: A treefmt module. See [options reference].
|
||||
|
||||
[options reference]: https://nixos.org/manual/nixpkgs/unstable#sec-treefmt-options-reference
|
||||
`module`
|
||||
: A treefmt module. See [options reference](#sec-treefmt-options-reference).
|
||||
*/
|
||||
evalConfig =
|
||||
module:
|
||||
@@ -49,9 +48,8 @@
|
||||
|
||||
# Inputs
|
||||
|
||||
: A treefmt module. See [options reference].
|
||||
|
||||
[options reference]: https://nixos.org/manual/nixpkgs/unstable#sec-treefmt-options-reference
|
||||
`module`
|
||||
: A treefmt module. See [options reference](#sec-treefmt-options-reference).
|
||||
*/
|
||||
withConfig =
|
||||
module:
|
||||
@@ -75,7 +73,8 @@
|
||||
# Inputs
|
||||
|
||||
`settings`
|
||||
: A settings module, used to build a treefmt config file
|
||||
: A settings module, used to build a treefmt config file.
|
||||
See [`settings` option reference](#opt-treefmt-settings).
|
||||
*/
|
||||
buildConfig =
|
||||
module:
|
||||
|
||||
Reference in New Issue
Block a user