feat: Use absolute URLs in API docs #2078 (#2088)

h2oai · Jul 31, 2023 · bf20d4f · bf20d4f
1 parent 98d450a
commit bf20d4f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/py/docs/templates/config.mako b/py/docs/templates/config.mako
@@ -28,7 +28,7 @@
 
     # A prefix to use for every HTML hyperlink in the generated documentation.
     # No prefix results in all links being relative.
-    link_prefix = ''
+    link_prefix = 'docs/api/'
 
     # Enable syntax highlighting for code/source blocks by including Highlight.js
     syntax_highlighting = False

diff --git a/py/docs/templates/text.mako b/py/docs/templates/text.mako
@@ -9,10 +9,9 @@
     name = name or dobj.qualname + ('()' if isinstance(dobj, pdoc.Function) else '')
     if isinstance(dobj, pdoc.External) and not external_links:
         return name
-    url = dobj.url(relative_to=module, link_prefix=link_prefix,
-                   top_ancestor=not show_inherited_members).replace('.html','')
+    url = dobj.url(link_prefix=link_prefix, top_ancestor=not show_inherited_members).replace('.html','')
     ## Replace "." with "_" because Docusarus doesn't seem to like "." in custom heading ids.
-    return '<a title="{}" href="{}">{}</a>'.format(dobj.refname, url.replace('.', '_'), name)
+    return f'<a title="{dobj.refname}" href={{useBaseUrl("{url.replace("h2o_wave/", "").replace(".", "_")}")}}>{name}</a>'
 
 
   def to_html(text):
@@ -84,6 +83,7 @@ title: ${'Namespace' if module.is_namespace else  \
                       'Package' if module.is_package and not module.supermodule else \
                       'Module'} ${module.name}
 ---
+import useBaseUrl from '@docusaurus/useBaseUrl';
 
 ${module.docstring | to_html}