-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
nim doc --project
shows '@@/' instead of '../' for relative paths to submodules
#14448
Comments
that's trivial to change; PR welcome (good change even if we later avoid hierarchy)
well that's what I wanted, to flatten hierarchy like we do for nimcache it would've simplified a lot of things IMO, but see araq's answer:
however we need to handle clashes
no, we need to handle name clashes somehow; we can't just ignore this edge case which nim allows; other aspectsnote that
docroot does not flatten (unlike what would appear from this example), but it shows path
we can add option:
|
@timotheecour Thanks for the quick fix! From the flat hierarchy examples:
Those links won't look too good.. they will look like |
wait which PR? also, do you have a repro that shows the |
I meant your upcoming PR for
:)
That's how the links generate in |
=> fixing it in #14454, please try and report back on PR :) |
The
nim doc --project
shows@@/
instead of../
in the relative paths to the nim project's submodules.This issue can be reproduced using the latest nim devel as of today (2020-05-25) as well.. f96555b
I have set up a minimal example repo to show this issue.
Example
Current Output
Open the generated
htmldocs/top.html
in a browser and you will see:Expected Output
Probably one of the two:
../
instead of@@/
Additional Information
@@/
to uniquify the modules that has leaked into the documentation too./cc @timotheecour @mratsim
The text was updated successfully, but these errors were encountered: