-
-
Notifications
You must be signed in to change notification settings - Fork 14.6k
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
doc: include nixdoc for lib.fetchers
#362453
Conversation
This currently fails to build with the following error:
Confusingly, It could be something like @NixOS/documentation-team, I may need some help with that. >_>' |
I'll have a look. |
@GetPsyched It seems this is caused because of a rendering bug when markup is used in the description. Didn't look into the details yet. Steps to fix this
nix-shell doc
redirects add-content ❬identifier❭ ❬path❭ Or manually:
"sec-functions-library-fetchers": [
"index.html#sec-functions-library-fetchers"
] It seems anchors cannot be used in the description. If you need more introduction sentences or links you should be able to add them to: /lib/fetchers.nix at the start of the file (see lib/attrsets.nix for example) If you do so please convert the single line comment into a doc-comment: |
I just found another bug. Feeding this markdown file causes nrd to never terminate. (Since # Heading{#1}
## heading [link](#somewhere) {#id} |
Oof. Thanks for investigating @hsjobeki! |
Thanks for debugging this, @hsjobeki ! I applied the suggested fix, and can confirm everything now renders as expected. |
Add
lib.fetchers
to thelibset
inlib-function-docs.nix
Things done
nix-build doc
Add a 👍 reaction to pull requests you find important.