-
Notifications
You must be signed in to change notification settings - Fork 9
Provide a schema for the htmlDocs output #44
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.
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
Open
lucperkins
wants to merge
12
commits into
main
Choose a base branch
from
html-docs-schema
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
668a214
Provide a schema for the htmlDocs output
lucperkins c5ab930
Make inline docs more explicit
lucperkins 4607008
Inherit what attribute
lucperkins a4f8981
Set isFlakeCheck to false
lucperkins 46ef59f
Make function inline
lucperkins ce8c9c0
Update Nixpkgs for CI shell tools
lucperkins cf36798
Set full Nixpkgs URL as environment variable
lucperkins e65b0bd
Fix merge conflicts with main
lucperkins c9cdfb6
Fix merge conflict
lucperkins 0de0603
Remove derivation check
lucperkins b4c19f9
Merge remote-tracking branch 'origin/main' into html-docs-schema
lucperkins cbc8a38
Merge remote-tracking branch 'origin/main' into html-docs-schema
lucperkins File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice if we had a convention/requirement about what the entry point to the docs should be (e.g. there should be an
$out/index.html) that we could document here (and maybe even enforce in the schema, though I don't think the meta-schema currently supports that). That way, tools like FlakeHub could provide a link to the docs automatically.Currently this doesn't seem to be the case for Nixpkgs (it has entry points like
$out/share/doc/nixpkgs/index.html).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would indeed be a nice convention. If you think the Nixpkgs folks would be amenable I could propose that upstream, but I suspect that a lot of things probably depend on that directory structure at this point.