[WONTFIX] [regression] nim doc foo/bar.nim should generate by default in htmldocs
instead of foo/bar.html (makes it hard to gitignore otherwise)
#8873
Labels
note: it's a semi-regression since previous behavior was already bad (but differently bad):
a few days ago:
nim doc
foo/bar.nim
generated
bar.html
now it generates
foo/bar.html
neither is good:
bar.html
could clash with existing modules (even regardless of [TODO] Nim now allows modules with same name in a package #8614 being merged, there could be other cases where 2 nimble projects are rooted under a same git repo; there are other cases)also it's bad to put stuff at top-level
foo/bar.html
puts generated files alongside non-generated sourcesproposal
nim doc foo/bar.nim
shall generate underhtmldocs/foo/bar.html
, as done fornim doc --project foo/bar.nim
[1]nim doc /abs/pathto/foo/bar.nim
shall generate underhtmldocs/abs/pathto/foo/bar.nim
nim doc
andnim doc --project
instead of duplicating logic to avoid further regressionsrationale
it's painful to gitignore the files generated by
nim doc
(I often need this command to run runnableExamples), as they're now scattered alongside source code and I don't wanna use a global*.html
rule in gitignore as it may cover source (non auto generated) html files.if it's in
htmldocs
it's trivial to gitignore italternatives
put it in
nimcache/htmldocs
; that way we don't even need a rule in gitignore (assuming that rule for nimcache is already in the nimble package)links
[1]
nim doc --project foo/bar.nim
generates indeed underhtmldocs/
, but it generates a full path nested under there, eg:htmldocs/Users/bob/pathto/foo/bar.html
, which is another regression, see #8874The text was updated successfully, but these errors were encountered: