fix docs

jacklowrie · jacklowrie · commit de6f6ceb9efc · 2025-10-17T16:54:25.000-04:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -31,44 +31,8 @@ jobs:
       - name: Install chordnet dependencies
         run: uv sync --frozen --all-extras --dev
 
-      - name: Build library docs (public API)
-        run: |
-          # pdoc default generates only public (non-private) members
-          uv run pdoc --docformat google -o docs/library chordnet
-
-      - name: Build developer docs (include private/internal)
-        run: |
-          # include private/internal members for developer docs
-          uv run pdoc --docformat google --private -o docs/dev chordnet
-
-      - name: Write simple landing index
-        run: |
-          mkdir -p docs
-          cat > docs/index.html <<'HTML'
-          <!doctype html>
-          <html>
-            <head>
-              <meta charset="utf-8" />
-              <meta name="viewport" content="width=device-width,initial-scale=1" />
-              <title>Chordnet documentation</title>
-              <style>
-                body { font-family: system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", Arial; max-width: 900px; margin: 3rem auto; padding: 0 1rem; }
-                h1 { margin-bottom: 0.25rem; }
-                p { color: #444; }
-                .links { margin-top: 1.25rem; }
-                .links a { display:inline-block; margin-right:1rem; padding: 0.5rem 0.75rem; background:#f3f4f6; color:#111; text-decoration:none; border-radius:6px; }
-              </style>
-            </head>
-            <body>
-              <h1>Chordnet documentation</h1>
-              <p>Choose the set of docs you want to view:</p>
-              <div class="links">
-                <a href="./library/">Library (public)</a>
-                <a href="./dev/">Developer (internal)</a>
-              </div>
-            </body>
-          </html>
-          HTML
+      - name: Build library docs
+        run: uv run pdoc --no-show-source --docformat google -o docs/ chordnet
 
       - uses: actions/upload-pages-artifact@v4
         with:
diff --git a/src/chordnet/__init__.py b/src/chordnet/__init__.py
@@ -1,7 +1,18 @@
-"""Library for distributed computing.
+"""# A Python Library for Distributed Computing
+
+ChordNet implements the chord protocol, introduced by Stoica et al.
+It implements a distributed hash table.
+
+## Project Links
+- [Source (github)](https://github.com/jacklowrie/chordnet)
+- [Issues](https://github.com/jacklowrie/chordnet/issues)
+- [Download](https://github.com/jacklowrie/chordnet/releases)
+- [History](https://github.com/jacklowrie/chordnet/releases)
+- [PyPI](https://pypi.org/project/chordnet/)
 
 .. include:: ../../README.md
-"""
+   :start-line: 16
+""" # noqa: D415 (this docstring is rendered by pdoc)
 from loguru import logger
 
 from .chordnet import ChordNet
