Apply suggestions from code review

- quick fix the relative paths
Deep-MI · Apr 12, 2024 · 489107f · 489107f
1 parent ba6e2fb
commit 489107f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -261,7 +261,7 @@ def linkcode_resolve(domain, info):
     # change occurs, but different (different repl str) replacements are not combined
     # "^\\/overview\\/intro\\.md#": "/overview/index.rst#",
     "^/?(.*)#(.*)ubuntu-(\\d{2})(\\d{2})": ("/\\1#\\2ubuntu-\\3-\\4",),
-    "^/readme\\.md(#.*)?$": ("/index.rst\\1", "/overview/intro.rst\\1"),
+    "^/?readme\\.md(#.*)?$": ("/index.rst\\1", "/overview/intro.rst\\1"),
     "^/?(overview/)?intro(\\.rst)?(#.*)?$": ("/overview/index.rst\\3",),
     "^/?(singularity|docker)/readme\\.md(#.*)?$": ("/overview/\\1.md\\2",),
     f"^/?({'|'.join(_script_dirs)})/readme\\.md(#.*)?$": ("/scripts/\\1.rst\\2",),

diff --git a/doc/sphinx_ext/fix_links/resolve.py b/doc/sphinx_ext/fix_links/resolve.py
@@ -61,7 +61,7 @@ def resolve_xref(
         source = node.attributes[attr]
         relpath = str(Path(env.srcdir).relative_to(Path.cwd()))
         # TODO fix hardcoded doc here
-        for prefix in (str(env.srcdir), relpath, "../", "../doc"):
+        for prefix in (str(env.srcdir), relpath, "../", "doc", "../doc"):
             if orig_source.startswith(prefix):
                 source = orig_source.removeprefix(prefix)
                 # maybe this already fixed the path?