doc(index): add link to homepage

nimpylib · Jan 3, 2025 · eb5b908 · eb5b908
1 parent 1124176
commit eb5b908
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -27,7 +27,7 @@ jobs:
       with:
         nim-version: ${{ env.nim-version }}
     - name: genDoc
-      run: nimble testDoc --index:on --project ${{ env.git-url-arg }} --outdir:${{ env.deploy-dir }}
+      run: nimble testDoc --index:on --project ${{ env.git-url-arg }} --outdir:${{ env.deploy-dir }} -d:homepage="${{ github.event.repository.homepage }}"
     - name: genLibDoc
       run: nimble testLibDoc ${{ env.git-url-arg }} --outdir:${{ env.lib-deploy-dir }}
     - name: "Copy to index.html"

diff --git a/src/pylib.nim b/src/pylib.nim
@@ -14,14 +14,19 @@ when defined(nimdoc):
   import std/strformat
   macro doc(s: static[string]): untyped = newCommentStmtNode s
 
+  template hs(s): string = "https://" & s
   const
-    RepoUrl = "https://github.com/nimpylib/pylib"
+    RepoUrl = hs"github.com/nimpylib/pylib"
     ReadmeUrl = RepoUrl & "?tab=readme-ov-file#nimpylib"
     WikiUrl = RepoUrl & "/wiki"
   template link(name, url: string): string = "[" & name & "](" & url & ")"
 
+  const
+    homepage{.strdefine.} = hs"nimpylib.github.io/pylib"
+
   doc "> Welcome to **NimPyLib** :sub:`" & Version & "`"  # Nim's Markdown is RST-extended
-  doc fmt"""- link to {link("repo", ReadmeUrl)}, {link("wiki", WikiUrl)}"""
+  doc fmt"""- link to {link("repo", ReadmeUrl)}, {link("wiki", WikiUrl)}
+""" & link("home", homepage)
   ## .. include:: ../doc/pylib.md
   doc ".. warning:: " & WarnLeniOps