doc: introduce fact injection workflow #313095
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce a workflow to extract documentation fragments from the nixpkgs tree. This way, we can encourage the autogeneration of documentation for sections that desync easily, such as the existing Python interpreters for a given nixpkgs version.
This workflow is introduced in a manual fashion. The contributor willing to autogenerate some fragment has to provide with a
fact.target
indicating the file where to look for a line<!-- FACT ${fact.id} -->
, which will be substituted with the contents offact.drv
before callingnixos-render-docs
.From this point, we can work on further automation/convenience. For example,
nixos-render-docs
could be extended to accept an include blockfacts
that looks for autogenerated fragments, which will potentially give better feedback to contributors.Future work
python-interpreter-table
.nixos-render-docs
with this workflow.