Skip to content

Publish API docs via pdoc and add docstrings - #13

Merged
nikhilvdev merged 1 commit into
mainfrom
feat/phase-9-docs
Sep 5, 2026
Merged

Publish API docs via pdoc and add docstrings#13
nikhilvdev merged 1 commit into
mainfrom
feat/phase-9-docs

Conversation

@nikhilvdev

Copy link
Copy Markdown
Owner

Add a GitHub Actions workflow (.github/workflows/docs.yml) to build and publish pdoc-generated API docs to GitHub Pages. Populate docstrings across the codebase (adapters, transports, plugins, CLI, formatter, worker, span, serverless, etc.) to produce a complete API reference; update README and CHANGELOG to advertise the docs and Kubernetes guidance. Expose CLI parser via build_parser for testing. Add a [docs] extra (pdoc) to pyproject.toml. Changes are documentation and docstring-focused; no functional behavior changes.

Summary

Checklist

  • ruff check . passes
  • mypy logquill passes (--strict on the public API)
  • pytest passes, and new surface area has test coverage
  • Public API additions are documented in README.md with a runnable example
  • CHANGELOG.md has an entry under Unreleased
  • If this touches the cross-language contract (levels, logger methods,
    record shape, transport/plugin contracts, config shape) shared with
    logquill-js, a matching tracking issue/PR is opened there

Scope

Add a GitHub Actions workflow (.github/workflows/docs.yml) to build and publish pdoc-generated API docs to GitHub Pages. Populate docstrings across the codebase (adapters, transports, plugins, CLI, formatter, worker, span, serverless, etc.) to produce a complete API reference; update README and CHANGELOG to advertise the docs and Kubernetes guidance. Expose CLI parser via build_parser for testing. Add a [docs] extra (pdoc) to pyproject.toml. Changes are documentation and docstring-focused; no functional behavior changes.
@nikhilvdev
nikhilvdev merged commit 1d59db5 into main Sep 5, 2026
6 checks passed
@nikhilvdev
nikhilvdev deleted the feat/phase-9-docs branch September 5, 2026 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant