Modules not linked in the main stdlib documentation

[konsumlamm]

Summary

Looking at the index, there are quite a few modules that are not linked from the main stdlib documentation (https://nim-lang.github.io/Nim/lib.html):

• https://gist.github.com/konsumlamm/d19d217ddd138d2172c7f48be2e9d71d

Most of them seem to be internal/experimental/unstable (note that some unstable modules are nevertheless linked), but some look like they should be linked from the main stdlib documentation page, for example:

• assertions
• atomics (added more modules to docs lib #17430)
  * [] channels
• enumerate (added more modules to docs lib #17430)
• io
• jsbigints
• jsonutils (added more modules to docs lib #17430)
• nre
• packedsets (Improve documentation for packedsets #16715)
• parsejson (added more modules to docs lib #17430)
• rdstdin (added more modules to docs lib #17430)
• setutils (Add std/setutils to lib.rst #16791)
• tempfiles (Add link to std/tempfiles in the docs; fix #19155 #19807)
• with (added more modules to docs lib #17430)
• std/exitprocs

Is there a reason they aren't linked? Are there more modules that should be linked? And perhaps there are some modules that are currently linked, but shouldn't be (like intsets)?

Related issue: #16046.

Possible solution

I'd be willing to create a PR to link all the missing modules.

As mentioned in the linked issue, while generating the documentation, one could automatically check that all modules are linked. For modules that are not supposed to be linked (internal, experimental, deprecated or unstable modules), there could be a way (a pragma or a special comment?) to mark them as such. Alternatively, they could be linked in a separate section ("Internal modules").

[metagn]

io and assertions are submodules of the system module

[konsumlamm]

io and assertions are submodules of the system module

I'm aware, but so are channels and threads, or are these different (other than only being available with --threads:on)? I think they should be linked at the top level anyway, since the system module is not necessarily where I would expect these things (when starting with Nim, I couldn't find anything related to File IO iirc). I'd still put them in the "Automatic imports" section of course, to make it clear that they're part of the system module. Though I'd also be fine with keeping them only being linked from the system docs.

[juancarlospaco]

Send PR maybe...

[ghost]

There's quite a lot of modules that are nowhere to be found in https://nim-lang.github.io/Nim/lib.html, for example quite a lot of modules from https://github.com/nim-lang/Nim/tree/devel/lib/std

[AFaurholt]

I noticed rdstdin was missing

[iacore]

Also missing:

• posix

[konsumlamm]

Also missing:

• posix

@locriacyber it's linked here: https://nim-lang.github.io/Nim/lib.html#wrappers-unix-specific.

[iacore]

Not searchable, not in "The Index" in 1.6.4. Try searching "fork".

[konsumlamm]

That's not what this issue is about though (it's about modules linked from https://nim-lang.github.io/Nim/lib.html). The index apparently not including the posix module seems to be a different issue, I'd suggest opening a new issue for it.

[Araq]

It's not a bug, we want the index to contain useful information and not the Posix API. You're not supposed to use the Posix APIs unless you know what you're doing and in that case, you don't need the index.