nim-lang / Nim

Nim is a statically typed compiled systems programming language. It combines successful concepts from mature languages like Python, Ada and Modula. Its design focuses on efficiency, expressiveness, and elegance (in that order of priority).
https://nim-lang.org
Other
16.55k stars 1.47k forks source link

Allow custom index filename in docgen #19949

Open SirOlaf opened 2 years ago

SirOlaf commented 2 years ago

Currently nim doc is hardcoded to use theindex.html as the index, as seen at https://github.com/nim-lang/Nim/blob/devel/compiler/nimpaths.nim#L32

The workaround for this seems to be to create an index.nim file that imports the main file of the project to force a index.html file to be generated, which the compiler itself does here https://github.com/nim-lang/Nim/blob/devel/compiler/index.nim

juancarlospaco commented 2 years ago

All OS support symlinks nowadays for a workaround, including Windows.