Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: introduce fact injection workflow #313095

Closed
wants to merge 2 commits into from
Closed

doc: introduce fact injection workflow #313095

wants to merge 2 commits into from

Commits on May 20, 2024

  1. doc: introduce fact injection workflow 

    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 of `fact.drv`
before calling `nixos-render-docs`.

From this point, we can work on further automation/convenience. For
example, `nixos-render-docs` could be extended to accept an include
block `facts` that looks for autogenerated fragments, which will
potentially give better feedback to contributors.
    @alejandrosame
    alejandrosame committed May 20, 2024
    Configuration menu
    Copy the full SHA
    a8a0467 View commit details
    Browse the repository at this point in the history

  2. doc: fix newlines

    @alejandrosame
    alejandrosame committed May 20, 2024
    Configuration menu
    Copy the full SHA
    4e40f81 View commit details
    Browse the repository at this point in the history