docs: add RFC-145 docstrings to lib functions and expose them in mkdocs - #158
Open
yajo wants to merge 1 commit into
Open
docs: add RFC-145 docstrings to lib functions and expose them in mkdocs#158yajo wants to merge 1 commit into
yajo wants to merge 1 commit into
Conversation
Add official RFC-145 doc-comments to public Blueprint library functions in lib/default.nix, including Type and Arguments sections rendered by nixdoc. Update the docs package to generate a library reference page automatically and wire it into the mkdocs navigation as 'Library Reference'. Also ignore the 'result' symlink produced by nix build. Assisted-by: OpenCode + Kimi k2.7-code
|
Tick the box to add this pull request to the merge queue (same as
|
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.
Add official RFC-145 doc-comments to public Blueprint library functions in lib/default.nix, including Type and Arguments sections rendered by nixdoc. Update the docs package to generate a library reference page automatically and wire it into the mkdocs navigation as 'Library Reference'.
Also ignore the 'result' symlink produced by nix build.
Assisted-by: OpenCode + Kimi k2.7-code
This is how these docs look like:
