pookiedocs 0.1.0

A minimal Python documentation site generator. Markdown and HTML to static site with live reload.

pookiedocs

A minimal Python documentation site generator. Reads markdown and HTML files from a folder, converts them to a clean static site, and serves them in development with live reload.

Installation

pip install pookiedocs

Quick start

pookiedocs init
pookiedocs serve

Build and deploy

pookiedocs build

This writes a fully self-contained static site to dist/. Deploy it by pointing any static file host at that folder.

Cloudflare Pages - set the build command to pip install pookiedocs && pookiedocs build and the output directory to dist.

Netlify - add a netlify.toml:

[build]
  command = "pip install pookiedocs && pookiedocs build"
  publish = "dist"

GitHub Pages - add a workflow that runs pookiedocs build --output _site and uploads the _site artifact with actions/upload-pages-artifact.

Docker - add a Dockerfile and you're done:

FROM python:3.12-slim AS builder
WORKDIR /app
COPY . .
RUN pip install --no-cache-dir pookiedocs && pookiedocs build

FROM nginx:alpine
COPY --from=builder /app/dist /usr/share/nginx/html
EXPOSE 80

docker build -t my-docs .
docker run -p 8080:80 my-docs

Deploy the image to GCP Cloud Run, Fly.io, Railway, or any container platform.

VPS - build locally, rsync the dist/ folder to your server, and serve it with nginx:

server {
    listen 80;
    server_name docs.example.com;
    root /var/www/docs;
    index index.html;

    location / {
        try_files $uri $uri/ $uri.html =404;
    }
}

See the Deployment guide for full examples including the complete GitHub Actions workflow and HTTPS setup with Certbot.

Documentation

Full documentation is available at https://pookiedocs.readthedocs.io

License

MIT