Misc docs (#31)

* fix pypi metadata

* add links to readme

* fix docs workflow to only run on tagged releases

* make it so docs can be run manually too

* minor bump

* update docs workflow to publish both library and dev docs

* update doc names

* fix docs

Author: jacklowrie

.github/workflows/docs.yml

@@ -1,11 +1,11 @@
 name: Documentation
 
-# build the documentation whenever there are new commits on main
+# build the documentation whenever there are new commits on main and for tags
 on:
   push:
-    branches:
-     tags:
+    tags:
        - '*'
+  workflow_dispatch:
 
 # security: restrict permissions for CI jobs.
 permissions:
@@ -16,7 +16,6 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      # setup
       - uses: actions/checkout@v5
         with:
           persist-credentials: false
@@ -32,15 +31,14 @@ jobs:
       - name: Install chordnet dependencies
         run: uv sync --frozen --all-extras --dev
 
-      - name: Build docs
-        run: uv run pdoc -o docs/ chordnet
+      - name: Build library docs
+        run: uv run pdoc --no-show-source --docformat google -o docs/ chordnet
 
       - uses: actions/upload-pages-artifact@v4
         with:
           path: docs/
 
-  # Deploy the artifact to GitHub pages.
-  # This is a separate job so that only actions/deploy-pages has the necessary permissions.
+  # Deploy the artifact to GitHub Pages.
   deploy:
     needs: build
     runs-on: ubuntu-latest

README.md

@@ -36,8 +36,9 @@ This fits with the concept of "joining" an existing ring network, or creating a
 new one. Examples follow this practice.
 
 ## Development
-See `CONTRIBUTING.md`.
+See `CONTRIBUTING.md` [(here)](https://github.com/jacklowrie/chordnet?tab=contributing-ov-file).
 
 ## Security
 If you discover a security issue, **please do not open a public issue**.
-See `SECURITY.md` for the full policy/reporting instructions.
+See the [security policy](https://github.com/jacklowrie/chordnet/security/policy)
+for reporting instructions.

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "chordnet"
-version = "2.0.0"
+version = "2.1.0"
 license = "MIT"
 license-files = ["LICENSE"]
 description = "Implementation of the chord peer-to-peer networking protocol, introduced by Stoica et al."
@@ -60,11 +60,21 @@ classifiers = [
     "Typing :: Typed",
 ]
 
+
 requires-python = ">=3.10"
 dependencies = [
     "loguru>=0.7.3",
 ]
 
+[project.urls]
+Homepage = "https://github.com/jacklowrie/chordnet"
+Source = "https://github.com/jacklowrie/chordnet"
+Documentation = "https://jacklowrie.github.io/chordnet/chordnet.html"
+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/"
+
 [build-system]
 requires = ["uv_build>=0.7.19,<0.8"]
 build-backend = "uv_build"

src/chordnet/__init__.py

@@ -1,4 +1,18 @@
-"""init.py: defines importable classes."""
+"""# 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