Conversation
Auto-generate the devshell.toml documentation from the nix modules. This also opens the road for having a `nixos-options`-like utility to query the devshell. And auto-generate the CLI config.
tennox
pushed a commit
to tennox/devshell
that referenced
this pull request
May 17, 2022
Auto-generate the devshell.toml documentation from the nix modules. This also opens the road for having a `nixos-options`-like utility to query the devshell. And auto-generate the CLI config.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR introduces the machinery that extracts the module configuration into
pure Nix values.
It outputs the markdown devshell.toml.md using that system. The output format
is still a bit rough to consume.
We are also one step closer to be able to query the module options using the
CLI and auto-generate the Go config struct from it.
The system is extensible so that third-party modules can also generate their
own docs.