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: doesn't include nixdoc for functions under pkgs/ #369483

Open
nbraud opened this issue Dec 30, 2024 · 1 comment
Open

doc: doesn't include nixdoc for functions under pkgs/ #369483

nbraud opened this issue Dec 30, 2024 · 1 comment
Labels
0.kind: bug Something is broken 6.topic: documentation Meta-discussion about documentation and its workflow

Comments

@nbraud
Copy link
Contributor

nbraud commented Dec 30, 2024

Describe the bug

Functions defined under pkgs/, such as pkgs.nixos, do not have their inline nixdoc rendered in the nixpkgs manual.

Steps To Reproduce

Search for pkgs.nixos (or equivalent) in the manual.

Expected behavior

The documentation of pkgs.nixos is available.

Notify maintainers

@NixOS/documentation-team

Note for maintainers: Please tag this issue in your PR.

Add a 👍 reaction to issues you find important.
@nbraud nbraud added 0.kind: bug Something is broken 6.topic: documentation Meta-discussion about documentation and its workflow labels Dec 30, 2024
@fricklerhandwerk
Copy link
Contributor

This is because currently those comments are not doc comments in the sense of RFC 145. Adding a second * would fix that, and IIRC pointing nixdoc to the right files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
0.kind: bug Something is broken 6.topic: documentation Meta-discussion about documentation and its workflow
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nbraud @fricklerhandwerk