Added documentation generation with doxygen #1847
Conversation
|
I'm surprised to see this as part of Nix itself and not a website about nix. Does it really belong here? |
|
It's useful for people hacking on Nix, so you will often want to generate it from your modified checkout of the source. |
|
Where did those files come from? They seem generated or standard, right? If generated, can Nix generate them for us and not pollute the repo with generated code? If they're from somewhere else, can we just make a fetcher? |
|
They're neither generated nor standard; they're modified from https://github.com/Velron/doxygen-bootstrapped |
|
Oh, wow, it's been a while since I made these files; it seems that they have modified |
|
Did you want to switch it to a fetcher-based doxygen model then? That might be quite appealing. |
|
I am interested in producing good nix documentation. But https://github.com/Velron/doxygen-bootstrapped hasn't been updated in 2 years and is broken w.r.t. doxygen >= 1.8.12 (current version is 1.8.14). This misnamed branch looks experimental and equally stale. Bigger issue, I think the nix source isn't doxygen-friendly. I can only get halfway useful doxygen docs with EXTRACT_ALL = YES. Am I mistaken to think this requires some non-trivial work on the actual source annotation? Besides work on the bootstrap stuff and builder integration. |
|
Closing as we're now going with markdown and probably another option for code/doc generation. |
This doesn't integrate the Doxygen generation into the build, but it does make it a bit easier to generate the Doxygen documentation. Should be mergeable without much review, as it only adds files.