Skip to content

docs: implement dynamic API docs, standardize configurations, and prep 0.1.2 release#14

Merged
markurtz merged 2 commits into
mainfrom
feature/upgrades-from-template
May 14, 2026
Merged

docs: implement dynamic API docs, standardize configurations, and prep 0.1.2 release#14
markurtz merged 2 commits into
mainfrom
feature/upgrades-from-template

Conversation

@markurtz
Copy link
Copy Markdown
Owner

Description

This PR introduces dynamic API documentation generation and standardizes repository configurations. Specifically, it implements automated literate API docs directly from the source code while cleaning up lingering template artifacts and preparing for the next minor release.

Key changes:

  • Dynamic API Docs: Replaced static API documentation with docs/scripts/gen_ref_pages.py utilizing mkdocs-gen-files and mkdocs-literate-nav to automatically generate deep API reference pages for all source code.
  • MkDocs Version Switcher: Configured the mike version provider in mkdocs.yml to correctly display the documentation version dropdown.
  • Testing Documentation: Added a comprehensive tests/README.md to document the project's testing tiers, architecture, and required pytest markers.
  • Project Metadata: Added Python version classifiers (3.10-3.14) and a Documentation URL link to pyproject.toml.
  • Cleanup: Cleaned up unused pytest markers, removed hardcoded template configs in mkdocs.yml, and updated GitHub Action workflows for proper versioning.
  • Release: Bumped package version to 0.1.2.

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update (changes to README.md, SUPPORT.md, docstrings, etc.)
  • 🛠️ Maintenance/Refactoring (non-breaking change that improves code structure or quality)

Test Plan

  • Run hatch run docs:build and verify that the API reference pages and SUMMARY.md are correctly generated in the output site without errors.
  • Run hatch run test:all to ensure no tests are broken by the test marker removals in pyproject.toml.
  • Verify the tests/README.md renders correctly and clearly outlines test guidelines.

Related Issues

  • Fixes # (Add issue number if applicable)

Screenshots / Visuals (if applicable)

(N/A)

Use of AI

  • Includes AI-assisted code completion
  • Includes code generated by an AI application
  • Includes AI-generated tests (NOTE: AI written tests should have a docstring that includes ## WRITTEN BY AI ##)

Checklist

Important

Please review and complete this checklist before submitting your PR. This helps our maintainers process your contribution faster and ensures it meets the quality standards of gitversioned.

  • "I certify that all code in this PR is my own, except as noted below."
  • I have read the CONTRIBUTING.md guide.
  • My code follows the established style guidelines of gitversioned.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings or errors.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

@github-actions
Copy link
Copy Markdown
Contributor

CI Development Pipeline Status

Pipeline: Completed successfully. View Run Details

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR prepares the 0.1.2 release while shifting the documentation site to dynamically generate API reference pages from src/ during MkDocs builds, and tightening CI/docs workflow ordering so docs can depend on test outputs (e.g., coverage artifacts).

Changes:

  • Add MkDocs-driven API reference generation via mkdocs-gen-files + mkdocs-literate-nav, and remove the old static API reference page.
  • Standardize project metadata/config (PyPI classifiers + docs URL, pytest marker cleanup, docs config cleanup) and add tests/README.md.
  • Update CI workflows so docs jobs explicitly depend on test jobs; bump package version to 0.1.2.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
tests/README.md Adds a testing guide describing tiers, markers, and Hatch commands.
src/gitversioned/__init__.py Bumps __version__ to 0.1.2.
pyproject.toml Adds classifiers/docs deps/docs URL; updates pytest marker configuration.
mkdocs.yml Adds gen-files + literate-nav plugins; config cleanup; mike version provider config.
docs/scripts/gen_ref_pages.py Generates per-module MkDocs reference pages and a literate nav summary.
docs/reference/index.md Updates API reference link to generated location and adds coverage report links.
docs/reference/api.md Removes the previous static API reference page.
docs/index.md Removes template community links (blog/slack).
docs/community/index.md Removes template community links (blog/slack).
CODE_OF_CONDUCT.md Replaces the enforcement contact email with a generic maintainer reference.
.github/workflows/release.yml Makes docs job depend on the test job.
.github/workflows/nightly.yml Makes docs job depend on the test job (and check-changes).
.github/workflows/main.yml Makes docs job depend on both quality and tests jobs.
.github/workflows/development.yml Makes docs job depend on both changes detection and tests jobs.
.github/PULL_REQUEST_TEMPLATE.md Simplifies checklist formatting (removes emoji) and AI-tests note.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread mkdocs.yml
Comment thread pyproject.toml
Comment thread CODE_OF_CONDUCT.md
@github-actions
Copy link
Copy Markdown
Contributor

CI Development Pipeline Status

Pipeline: Completed successfully. View Run Details

@markurtz markurtz force-pushed the feature/upgrades-from-template branch from d9db492 to a14e65d Compare May 14, 2026 20:52
@markurtz markurtz merged commit ecfe50d into main May 14, 2026
27 checks passed
@markurtz markurtz deleted the feature/upgrades-from-template branch May 14, 2026 20:53
@github-actions
Copy link
Copy Markdown
Contributor

CI Development Pipeline Status

Pipeline: Completed successfully. View Run Details

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.

2 participants