Handle .md and .nim paths uniformly in findRefFile

Author: a-mr

compiler/docgen.nim

@@ -264,17 +264,22 @@ template declareClosures =
       result = getCurrentDir() / s
       if not fileExists(result): result = ""
 
-  proc docgenFindRefFile(targetRelPath: string, isMarkup: bool):
+  proc docgenFindRefFile(targetRelPath: string):
          tuple[targetPath: string, linkRelPath: string] {.gcsafe.} =
     let fromDir = splitFile(destFile).dir  # dir where we reference from
     let basedir = os.splitFile(currentFilename.string).dir
-    if isMarkup:  # .rst/.md file
-      result.targetPath = fromDir / targetRelPath
-    else:  # .nim file
-      let outDirPath: RelativeFile =
-          presentationPath(conf, AbsoluteFile(basedir / targetRelPath))
-            # use presentationPath because `..` path can be be mangled to `_._`
-      result.targetPath = string(conf.outDir / outDirPath)
+    let outDirPath: RelativeFile =
+        presentationPath(conf, AbsoluteFile(basedir / targetRelPath))
+          # use presentationPath because `..` path can be be mangled to `_._`
+    result.targetPath = string(conf.outDir / outDirPath)
+    if not fileExists(result.targetPath):
+      # this can happen if targetRelPath goes to parent directory `OUTDIR/..`.
+      # Trying it, this may cause ambiguities, but allows us to insert
+      # "packages" into each other, which is actually used in Nim repo itself.
+      let destPath = fromDir / targetRelPath
+      if destPath != result.targetPath and fileExists(destPath):
+        result.targetPath = destPath
+
     result.linkRelPath = relativePath(result.targetPath.splitFile.dir,
                                       fromDir).replace('\\', '/')
 

lib/packages/docutils/rst.nim

@@ -80,7 +80,7 @@ type
                        arg: string) {.closure, gcsafe.} ## what to do in case of an error
   FindFileHandler* = proc (filename: string): string {.closure, gcsafe.}
   FindRefFileHandler* =
-    proc (targetRelPath: string, isMarkup: bool):
+    proc (targetRelPath: string):
          tuple[targetPath: string, linkRelPath: string] {.closure, gcsafe.}
     ## returns where .html or .idx file should be found by its relative path.
 
@@ -473,7 +473,7 @@ proc defaultFindFile*(filename: string): string =
   if fileExists(filename): result = filename
   else: result = ""
 
-proc defaultFindRefFile*(filename: string, isMarkup: bool): (string, string) =
+proc defaultFindRefFile*(filename: string): (string, string) =
   (filename, "")
 
 proc defaultRole(options: RstParseOptions): string =
@@ -3499,8 +3499,7 @@ proc loadIdxFile(s: var PRstSharedState, origFilename: string) =
     rstMessage(s.filenames, s.msgHandler, s.idxImports[origFilename].fromInfo,
                meCannotOpenFile, origFilename & ": unknown extension")
   let idxFilename = dir / basename & ".idx"
-  let (idxPath, linkRelPath) = s.findRefFile(
-      idxFilename, isMarkup = ext in [".md", ".rst"])
+  let (idxPath, linkRelPath) = s.findRefFile(idxFilename)
   s.idxImports[origFilename].linkRelPath = linkRelPath
   var
     fileEntries: seq[IndexEntry]
@@ -3772,7 +3771,8 @@ proc resolveSubs*(s: PRstSharedState, n: PRstNode): PRstNode =
 proc completePass2*(s: PRstSharedState) =
   for (filename, importdocInfo) in s.idxImports.pairs:
     if not importdocInfo.used:
-      rstMessage(s, mwUnusedImportdoc, filename)
+      rstMessage(s.filenames, s.msgHandler, importdocInfo.fromInfo,
+                 mwUnusedImportdoc, filename)
 
 proc rstParse*(text, filename: string,
                line, column: int,

lib/packages/docutils/rstgen.nim

@@ -1528,7 +1528,7 @@ proc rstToHtml*(s: string, options: RstParseOptions,
   proc myFindFile(filename: string): string =
     # we don't find any files in online mode:
     result = ""
-  proc myFindRefFile(filename: string, isMarkup: bool): (string, string) =
+  proc myFindRefFile(filename: string): (string, string) =
     result = ("", "")
 
   const filen = "input"