[INTT-49] feat: Autogenerate documentation for module#19
Conversation
RasmusRendal
force-pushed
the
RasmusRendal/gen_docs
branch
from
b4aeca9 to
f1f0f91
Compare
This introduces a basic repository structure that does not yet define any real standards, but simply sets up the project sufficiently to base future work on.
There was a problem hiding this comment.
We discussed this at the summit, but for posterity, we decided not to merge this.
In part because of the comment below, but the generated docs are also not quite good enough for our purposes (e.g. the installation instructions are just wrong).
We'd like to simply implement what is needed for this ourselves; it's not exactly rocket science. pkgs.nixosOptionsDoc does most of the heavy lifting without pulling in any additional software sources, we just need to hook calling it up to a package and add a bit of fluff.
There was a problem hiding this comment.
This is a lot of dependency burden for no good reason. This kind of sprawl is a supply chain risk, but also makes nix operations much slower than need-be.
Some dependencies are expected, but literally 4000 lines' worth just for nix doc codegen is excessive.
If we want people who also have other things in their life outside of Nix to use this, we probably want a nicer overview of the options, besides just looking at the source code. Apparently, by default the flake.parts-website module results in the `default` package being the generated documentation. But I don't actually think this is a problem.
RasmusRendal
force-pushed
the
RasmusRendal/gen_docs
branch
from
f1f0f91 to
9cfe764
Compare
tlater-famedly
force-pushed
the
tlater/skeleton
branch
9 times, most recently
from
a7c8220 to
09d1f18
Compare
tlater-famedly
changed the title
2 participants
If we want people who also have other things in their life outside of Nix
to use this, we probably want a nicer overview of the options, besides
just looking at the source code.
Apparently, by default the flake.parts-website module results in the
defaultpackage being the generated documentation. But I don't actuallythink this is a problem.