jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docgen: fix #14448 show @@ as .. in href text (#14451)

Browse source
This commit is contained in:
Timothee Cour 2020-05-25 18:16:00 -07:00 • committed by GitHub
commit 55758920f4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

6
compiler/docgen.nim
View file

@ -100,7 +100,7 @@ proc presentationPath*(conf: ConfigRef, file: AbsoluteFile, isTitle = false): Re
if isTitle: if isTitle:
result = result.string.nativeToUnix.RelativeFile result = result.string.nativeToUnix.RelativeFile
else: else:
result = result.string.replace("..", "@@").RelativeFile ## refs #13223 result = result.string.replace("..", dotdotMangle).RelativeFile
doAssert not result.isEmpty doAssert not result.isEmpty
doAssert not isAbsolute(result.string) doAssert not isAbsolute(result.string)
@ -926,7 +926,7 @@ proc traceDeps(d: PDoc, it: PNode) =
if d.section[k] != nil: d.section[k].add(", ") if d.section[k] != nil: d.section[k].add(", ")
dispA(d.conf, d.section[k], dispA(d.conf, d.section[k],
"<a class=\"reference external\" href=\"$2\">$1</a>", "<a class=\"reference external\" href=\"$2\">$1</a>",
"$1", [rope esc(d.target, changeFileExt(external, "")), "$1", [rope esc(d.target, external.prettyLink),
rope changeFileExt(external, "html")]) rope changeFileExt(external, "html")])
proc exportSym(d: PDoc; s: PSym) = proc exportSym(d: PDoc; s: PSym) =
@ -936,7 +936,7 @@ proc exportSym(d: PDoc; s: PSym) =
if d.section[k] != nil: d.section[k].add(", ") if d.section[k] != nil: d.section[k].add(", ")
dispA(d.conf, d.section[k], dispA(d.conf, d.section[k],
"<a class=\"reference external\" href=\"$2\">$1</a>", "<a class=\"reference external\" href=\"$2\">$1</a>",
"$1", [rope esc(d.target, changeFileExt(external, "")), "$1", [rope esc(d.target, external.prettyLink),
rope changeFileExt(external, "html")]) rope changeFileExt(external, "html")])
elif s.kind != skModule and s.owner != nil: elif s.kind != skModule and s.owner != nil:
let module = originatingModule(s) let module = originatingModule(s)

7
lib/packages/docutils/rstgen.nim
View file

@ -78,6 +78,11 @@ type
testCmd: string testCmd: string
status: int status: int
const dotdotMangle* = "@@" ## refs #13223
proc prettyLink*(file: string): string =
changeFileExt(file, "").replace(dotdotMangle, "..")
proc init(p: var CodeBlockParams) = proc init(p: var CodeBlockParams) =
## Default initialisation of CodeBlockParams to sane values. ## Default initialisation of CodeBlockParams to sane values.
p.startLine = 1 p.startLine = 1
@ -574,7 +579,7 @@ proc generateModuleJumps(modules: seq[string]): string =
var chunks: seq[string] = @[] var chunks: seq[string] = @[]
for name in modules: for name in modules:
chunks.add("<a href=\"" & name & ".html\">" & name & "</a>") chunks.add("<a href=\"$1.html\">$2</a>" % [name, name.prettyLink])
result.add(chunks.join(", ") & ".<br/>") result.add(chunks.join(", ") & ".<br/>")