search

nix-community / nixdoc

Tool to generate documentation for Nix library functions [maintainer=@infinisil]
GNU General Public License v3.0
123 stars 15 forks source link

Allow empty prefix #122

Closed hsjobeki closed 2 months ago

hsjobeki commented 4 months ago

Requires #121 to be merged first.

This closes #119

empty prefix or catgeory is possible when this gets merged

nixos-discourse commented 4 months ago

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2024-04-25-documentation-team-meeting-notes-122/44080/1

hsjobeki commented 3 months ago

@infinisil should we merge this?

It would allow this PR to move on: https://github.com/NixOS/nixpkgs/pull/305847

It also allows us to utilize doc-comments for things outside of lib where the path prefix doesn't include two dots . i.e. pkgs.*functions.

hsjobeki commented 2 months ago

Hmm I don't like how this breaks rendering when the flag is specified. How about just making it so that the . is only added if the prefix is non-empty?

Just pushed a new commit, to simply allow empty prefixes.

Maybe a future pr could make the seperator configurable

hsjobeki commented 2 months ago

@infinisil any open points? Otherwise could we merge this.