Skip to content

Add Zensical docs, and update doc comments - #11

Merged
ahcodedev merged 1 commit into
mainfrom
setup-docs
Nov 9, 2026
Merged

ahcodedev merged 1 commit into
mainfrom
setup-docs

Conversation

@ahcodedev

@ahcodedev ahcodedev commented Nov 9, 2026 •

Copy link
Copy Markdown
Owner

Summary

Adds a documentation site built with Zensical, deployed to GitHub Pages, and documents the fields in the API models.

Docs site

  • New docs dependency group (zensical, mkdocstrings[python]), installed by just sync
  • just docs serves the site locally and just docs-build runs a strict build into site/

Deploy

  • New .github/workflows/docs.yml builds the docs on pushes and PRs to main, and deploys to GitHub Pages on pushes to main and manual runs using actions/upload-pages-artifact and actions/deploy-pages.

Field docstrings

  • models.py, requests.py, responses.py, and types.py: inline # comments became attribute docstrings, and docstrings were added where meaning isn't obvious (pennies, zero dates, product vs. offer IDs, reverse auctions, SKU rules, per-category price meanings, coin grades), checked against the PriceCharting API documentation
  • PriceChartingModel sets use_attribute_docstrings=True, so docstrings also become pydantic field descriptions

Changelog removal

  • Removed CHANGELOG.md and the changelog step in release.yml. GitHub Release notes are now the changelog.

Docs updates

  • README.md, CI.md, RELEASE.md, and the PR template are updated for the docs site, the new workflow, the changelog removal, and corrected details (Dependabot schedule, Python 3.15)

Related Issues

None

Type of Change

documentation

Checklist

  • just lint passes
  • just test passes
  • README.md updated if needed
  • Release label added

@ahcodedev ahcodedev added the documentation Documentation (patch version bump) label Nov 9, 2026
@ahcodedev
ahcodedev merged commit 57c06ec into main Nov 9, 2026
11 checks passed
@ahcodedev
ahcodedev deleted the setup-docs branch November 9, 2026 04:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation (patch version bump)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant