Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"--out:" switch is ineffective with "nim doc" [regression] #11312

Closed
kaushalmodi opened this issue May 23, 2019 · 1 comment

Comments

Projects
None yet
2 participants
@kaushalmodi
Copy link
Contributor

commented May 23, 2019

There's a nim doc --out: .. behavior regression that went unnoticed for a while.

Example

Run:

nim doc --out:index.html foo.nim

Current Output

Now it always generates foo.html even when I have specified the output file to be named index.html.

Expected Output

The generate doc HTML file should be named index.html and not foo.html.

Additional Information

$ nim -v
Nim Compiler Version 0.19.9 [Linux: amd64]
Compiled at 2019-05-22
Copyright (c) 2006-2019 by Andreas Rumpf

git hash: 3e0fac7c20c624ba69ecff615af6bc6a78dcaeec
active boot switches: -d:release

/cc @PMunch @narimiran

@Araq Araq closed this in 1a8ef6b May 24, 2019

kaushalmodi added a commit to kaushalmodi/nim_config that referenced this issue May 24, 2019

Revert the workaround for nim-lang/Nim#11312
That bug is now fixed in
nim-lang/Nim@1a8ef6b.

This reverts commit 67d8e2b and
b7ef26d.
@kaushalmodi

This comment has been minimized.

Copy link
Contributor Author

commented May 24, 2019

Thank you! I confirm the fix.

I have a sort of related issue where the --out: value does not propagate to the generated .idx file when using --index:on switch too. I have opened that issue separately at #11325.

kaushalmodi added a commit to kaushalmodi/Nim that referenced this issue May 24, 2019

kaushalmodi added a commit to kaushalmodi/Nim that referenced this issue May 25, 2019

Araq added a commit that referenced this issue May 25, 2019

Use the correct HTML file reference in "nim doc" generated idx files (#…
…11326)

* Use the correct HTML file reference in "nim doc" generated idx files

Now "nim doc --out:foo.html --index:on bar.nim" generates "foo.html"
and the generated "bar.idx" contains references to "foo.html".

Fixes #11325.

* Refactor the nim doc tester to extend it for more tests

* Reference the HTML files relative to the outDir, not project dir

* Add test for issues #11312 and #11325

- #11312
- #11325
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.