!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

431 Members
Discussion about documentation improvements around the Nix ecosystem90 Servers

Load older messages


SenderMessageTime
22 Jun 2023
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @pennae:matrix.eno.space
asymmetric: your snapshot tests unknowingly broke pattern argument formatting 😅
Lol wat, how? 😅
17:44:34
@pennae:matrix.eno.spacepennaeprint_indented broke17:44:56
@pennae:matrix.eno.spacepennaereplaced the whole thing with textwrap now, should be much better17:45:21
@pennae:matrix.eno.spacepennaealso for some reason the set of function nixdoc finds is different than when we started, not sure whether the rnix update is the reason or something else17:47:39
@pennae:matrix.eno.spacepennae the rnix update seems to also have lost a number of entries for libraries that use let ...; in { inherit ...; }, sigh 18:00:22
@pennae:matrix.eno.spacepennaethe nixdoc approach to finding docs is just ... wrong, really :/18:03:00
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @pennae:matrix.eno.space
the nixdoc approach to finding docs is just ... wrong, really :/
What would you suggest instead?
20:25:07
@pennae:matrix.eno.spacepennae short term, no alternative
long term, put docs awareness into nix as suggested by the docs syntax rfc
20:26:18
@pennae:matrix.eno.spacepennaelooks like we got it working again with mostly the same semantics as the old nixdoc, but it's very fragile :(20:29:22
@pennae:matrix.eno.spacepennaeit's not realistically possible to extract function docs from nix files without evaluating them, if it's not in nix itself there will always be confusing corner cases. we're not super hopeful that it'll end up being added to nix because the use case is disproportionately small compared to the cost of having that functionality. we may have to codify lib docs syntax somehow else instead20:35:41
23 Jun 2023
@fricklerhandwerk:matrix.orgfricklerhandwerkWhat about something naive like wrapping all library functions in attribute sets and exposing just the functions as well as that large collection of metadata?06:31:40
@fricklerhandwerk:matrix.orgfricklerhandwerk Also there still exists the ominous __functor 06:36:00
@sternenseemann:systemli.orgsterni
In reply to @pennae:matrix.eno.space
it does look totally possible, but not something we can easily fit into the docbook removal process
that’s fine but it probably only makes sense to do after that is finished
09:17:27
@sternenseemann:systemli.orgsterni
In reply to @pennae:matrix.eno.space
short term, no alternative
long term, put docs awareness into nix as suggested by the docs syntax rfc
that’s not a silber bullet as well
09:18:44
@sternenseemann:systemli.orgsterni
In reply to @fricklerhandwerk:matrix.org
What about something naive like wrapping all library functions in attribute sets and exposing just the functions as well as that large collection of metadata?
extra runtime overhead
09:19:28
@fricklerhandwerk:matrix.orgfricklerhandwerk sterni: what's your take on it then? 09:53:51
@pennae:matrix.eno.spacepennae
In reply to @sternenseemann:systemli.org
that’s not a silber bullet as well
it's closer to one than what we have now. if nix could optionally store and return, for each attribute or lambda arg, the doc comment that was attached to it we'd be golden for pretty much everything
13:33:02
@pennae:matrix.eno.spacepennaedoing so would cause overhead, but that can be mitigated sufficient to be just about free13:33:29
@pennae:matrix.eno.spacepennae nixdoc pr for nixpkgs manual dedocbookification is now done. we'll have to clean up the nixpkgs pr a lot before sending still
(cc asymmetric)
13:52:55
@pennae:matrix.eno.spacepennaeexcellent, the macos build failed for unrelated reasons :D14:07:43
@pennae:matrix.eno.spacepennaenixdoc should probably sort its output, shouldn't it18:29:48
24 Jun 2023
@pennae:matrix.eno.spacepennae zmitchell: with any luck your june in docs could still include docbook removal 21:49:37
25 Jun 2023
@pennae:matrix.eno.spacepennaelooking at the recent prs to nix.dev ... nixos-render-docs has a lot of features from myst, which sphinx uses 🤔23:55:08
27 Jun 2023
@zmitchell:matrix.org@zmitchell:matrix.org
In reply to @pennae:matrix.eno.space
looking at the recent prs to nix.dev ... nixos-render-docs has a lot of features from myst, which sphinx uses 🤔
What are you suggesting?
03:58:28
@zmitchell:matrix.org@zmitchell:matrix.orgI've pushed another commit to the contributing workflow (https://github.com/NixOS/nix.dev/pull/596), but there's still open questions about the git workflow. Using a separate branch for work is less than ideal, but I don't see another way around it unless we can mark pages as drafts and have Sphinx ignore them when publishing. Most static site generators can do this by default, but I'm not sure if Sphinx can without complaining about it during builds and breaking CI. There's probably a workaround, I haven't thought about it too hard.04:01:07
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @zmitchell:matrix.org
I've pushed another commit to the contributing workflow (https://github.com/NixOS/nix.dev/pull/596), but there's still open questions about the git workflow. Using a separate branch for work is less than ideal, but I don't see another way around it unless we can mark pages as drafts and have Sphinx ignore them when publishing. Most static site generators can do this by default, but I'm not sure if Sphinx can without complaining about it during builds and breaking CI. There's probably a workaround, I haven't thought about it too hard.
Silvan proposed dumping drafts into the maintainers directory where they are not rendered
06:27:54
@mightyiam:matrix.org@mightyiam:matrix.org joined the room.09:57:54
@pennae:matrix.eno.spacepennae
In reply to @zmitchell:matrix.org
What are you suggesting?
not suggesting anything yet, but there may be a real possibility that nixos-render-docs could be used for nix.dev too. at least from a markup perspective, others (importantly: search!) would need a whole lot of work that is probably better spent doing other things
11:58:06
@zmitchell:matrix.org@zmitchell:matrix.org
In reply to @fricklerhandwerk:matrix.org
Silvan proposed dumping drafts into the maintainers directory where they are not rendered
That's fine with me, we just discussed something different at the time.
15:37:10
@zmitchell:matrix.org@zmitchell:matrix.org Is there any documentation explaining what's shown while you're building a package e.g. [1/32/39 built, 37 copied (26.4/26.5 MiB), 9.6 MiB DL]? 17:45:28

Show newer messages


Back to Room ListRoom Version: 6