flake.parts-website
This module is used to build the flake.parts website.
Refer to the Generate Documentation guide for more information.
Its interface is subject to change but moves slowly and changes should be simple.
Installation
To use these options, add to your flake inputs:
flake.parts-website.url = "github:hercules-ci/flake.parts-website";
and inside the mkFlake:
imports = [
inputs.flake.parts-website.flakeModules.empty-site
];
Run nix flake lock and you're set.
Options
perSystem.render.inputs
Which modules to render.
Type: attribute set of (submodule)
Declared by:
perSystem.render.inputs.<name>.attributePath
Default value for attributePaths.
Type: unspecified value
Default:
[
"flakeModule"
]
Declared by:
perSystem.render.inputs.<name>.attributePaths
Flake output attribute path to import.
Type: list of list of string
Default:
[
[
"flakeModule"
]
]
Example:
[
"flakeModules"
"default"
]
Declared by:
perSystem.render.inputs.<name>.baseUrl
URL prefix for source location links.
Type: string
Declared by:
perSystem.render.inputs.<name>.filterTransformOptions
Function to customize the set of options to render for this input.
This is mostly for overriding the default behavior, which excludes the options of the flake-parts module itself, unless it’s the flake-parts core itself that’s being rendered.
Type: unspecified value
Default:
<function, args: {baseUrl, coreOptDecls, sourceName, sourcePath}>
Declared by:
perSystem.render.inputs.<name>.fixupAnchorsBaseUrl
Replace same-page links without opt- prefix with this prefix.
Type: null or string
Default:
null
Declared by:
perSystem.render.inputs.<name>.flake
A flake.
Type: raw value
Default:
inputs.${name}
Declared by:
perSystem.render.inputs.<name>.flakeRef
Flake reference string that refers to the flake to import, used in the generated text for the installation instructions, see installation.
Type: string
Default:
Determined from config.baseUrl.
Declared by:
perSystem.render.inputs.<name>.getModules
Get the modules to render.
Type: function that evaluates to a(n) list of raw value
Default:
Derived from config.attributePaths, <name>
Declared by:
perSystem.render.inputs.<name>.installation
Installation paragraph between installation and options.
Type: string
Default: Generated
Declared by:
perSystem.render.inputs.<name>.installationDeclareInput
Whether to show how to declare the input.
Type: boolean
Default:
true
Declared by:
perSystem.render.inputs.<name>.intro
Introductory paragraph between title and installation.
Type: string
Declared by:
perSystem.render.inputs.<name>.isEmpty
Whether this input is empty, ie has no documented options.
Normally this is indicative of a inaccurate tracking of declaration
sources, or declaring options in perSystem.config instead of
mkPerSystemOption.
If your module really has no options of its own (ie only imports and config), set this to true.
Type: boolean
Default:
false
Declared by:
perSystem.render.inputs.<name>.menu.enable
Whether to add this page to the navigation menu.
Modules in the flake-parts repo disable this, as they’re hardcoded into the menu.
Type: boolean
Default:
true
Declared by:
perSystem.render.inputs.<name>.menu.title
Title of the menu entry.
Type: string
Default:
"‹name›"
Declared by:
perSystem.render.inputs.<name>.preface
Stuff between the title and the options.
Type: string
Default:
intro followed by installation
Declared by:
perSystem.render.inputs.<name>.rendered
A package containing the generated documentation page.
Type: package (read only)
Declared by:
perSystem.render.inputs.<name>.separateEval
Whether to include this in the main evaluation.
By default, all modules are evaluated together, except ones that enable this option.
Type: boolean
Default:
false
Declared by:
perSystem.render.inputs.<name>.sourceName
Name by which the source is shown in the list of declarations.
Type: string
Default:
"‹name›"
Declared by:
perSystem.render.inputs.<name>.sourcePath
Source path in which the modules are contained.
Type: path
Default:
config.flake.outPath
Declared by:
perSystem.render.inputs.<name>.title
Title of the markdown page.
Type: string
Default:
"‹name›"
Declared by:
perSystem.render.officialFlakeInputs
The inputs from the flake.parts-website flake.
This supplements the inputs module argument when the rendering module is used in a different flake.
Type: raw value (read only)
Declared by: