| 3 Nov 2023 |
infinisil | Johannes Kirschbauer @hsjobeki: I'm the main user of those. They're added by nixdoc. I'm using them because it's the only way to reference functions. | 09:12:35 |
infinisil | I generally inspect the web elements to find them | 09:13:29 |
@johannes.kirschbauer:scs.ems.host | In reply to @infinisil:matrix.org I generally inspect the web elements to find them And now we depend on a certain web-elements beeing present on the same page ^^. I'll try to find a solution for this., because it hinders us moving to newer formats. Any suggestions?
idea:
Something like
see [lib.lists.foldl]
Without any further. The rendering framework can transform this into references for achor tags, if it uses them. I tried using a different rendering framework that uses seperate pages and doesnt have those exact anchors.
| 09:17:13 |
@johannes.kirschbauer:scs.ems.host | In reply to @infinisil:matrix.org I generally inspect the web elements to find them * And now we depend on a certain web-elements beeing present on the same page ^^. I'll try to find a solution for this., because it hinders us moving to newer formats. Any suggestions?
idea:
Something like
see [lib.lists.foldl']
Without any further. The rendering framework can transform this into references for achor tags, if it uses them. I tried using a different rendering framework that uses seperate pages and doesnt have those exact anchors.
| 09:17:39 |
@johannes.kirschbauer:scs.ems.host | That opens the box of pandora: context aware references ^^
{
/**
# Params
- [a] A number
- [b] Another number
*/
lib.foo = a: b: a +b;
}
š
| 09:19:43 |
@johannes.kirschbauer:scs.ems.host | * That opens the box of pandora: context aware references ^^
{
/**
See also [lib.trivial.add]
# Params
- [a] A number
- [b] Another number
*/
lib.foo = a: b: a +b;
}
š
| 09:20:17 |
@johannes.kirschbauer:scs.ems.host | Some references refer to internal things, while some refer to external attributes.
Just playing around with the idea š | 09:21:31 |
asymmetric | Can't run nix.dev devmode:
⯠nix-shell --run devmode
error:
⦠while calling the 'import' builtin
at «string»:1:2:
1| (import <nixpkgs> {}).bashInteractive
| ^
⦠while calling the 'findFile' builtin
at «string»:1:9:
1| (import <nixpkgs> {}).bashInteractive
| ^
error: file 'nixpkgs' was not found in the Nix search path (add it using $NIX_PATH or -I)
at «none»:0: (source not available)
will use bash from your environment
Doing an initial build of the docs...
| 09:21:36 |
asymmetric | cc fricklerhandwerk alejandrosame | 09:22:33 |
@johannes.kirschbauer:scs.ems.host | Whats in your $NIX_PATH, is it empty ? | 09:23:00 |
asymmetric | In reply to @johannes.kirschbauer:scs.ems.host Whats in your $NIX_PATH, is it empty ? nope, it has nixpkgs=/nix/store/... | 09:23:56 |
infinisil | Johannes Kirschbauer @hsjobeki: We can freely change the source code (just needs some automated/manual work) though I guess the anchors should stay the same. I don't really care about the format as long as it works :) | 09:24:24 |
alejandrosame | In reply to @asymmetric:matrix.dapp.org.uk
Can't run nix.dev devmode:
⯠nix-shell --run devmode
error:
⦠while calling the 'import' builtin
at «string»:1:2:
1| (import <nixpkgs> {}).bashInteractive
| ^
⦠while calling the 'findFile' builtin
at «string»:1:9:
1| (import <nixpkgs> {}).bashInteractive
| ^
error: file 'nixpkgs' was not found in the Nix search path (add it using $NIX_PATH or -I)
at «none»:0: (source not available)
will use bash from your environment
Doing an initial build of the docs...
I think my new PR fixes this completely. At least it does handle properly the syntax error you mention in your issue :) | 14:53:20 |
fricklerhandwerk | In reply to @johannes.kirschbauer:scs.ems.host
It might be personal thing... I don't like those achor tags in our nix code because strictly bind our lib documentation to the current manual rendering, with those exact achor tags. Changing something in rendering (e.g. splitting in multiple pages) now means also breaking the documentation.
See [`lib.lists.foldl'`](#function-library-lib.lists.foldl-prime) but for attribute sets.
Has this been discussed in the documentation team? I'd prefer to keep the actual content un-opinionated from our rendering framework, and place neutral references, that are autoresolved instead of hard links, which break when touching the thing.
We havenāt discussed this, but someone recently made me aware of https://github.com/stepchowfun/tagref
I think itās a nice idea, and seems like it would scale better than the reference system Sphinx uses (which in its MyST incarnation canāt discern between file paths and references⦠it produces a lot of busywork). | 15:11:39 |
fricklerhandwerk | In reply to @alejandrosame:matrix.org I think my new PR fixes this completely. At least it does handle properly the syntax error you mention in your issue :) Iām not sure why there is a need for NIX_PATH to be set. Why and when did it even break? It worked a couple of days ago. | 15:13:28 |
alejandrosame | In reply to @fricklerhandwerk:matrix.org Iām not sure why there is a need for NIX_PATH to be set. Why and when did it even break? It worked a couple of days ago. Where is NIX_PATH set? I don't follow. | 15:25:11 |
fricklerhandwerk | The error complains about NIX_PATH not containing nixpkgs | 15:33:13 |
alejandrosame | Ah, I was talking about the error in the issue https://github.com/NixOS/nix.dev/issues/787 | 16:06:38 |
asymmetric | https://github.com/NixOS/nix.dev/pull/645#issuecomment-1792303015 | 17:40:13 |