docs: implement dynamic API docs, standardize configurations, and prep 0.1.2 release#14
Merged
Merged
Conversation
…PI docs, latest standards, and proper version displays and more
Contributor
CI Development Pipeline Status✅ Pipeline: Completed successfully. View Run Details |
There was a problem hiding this comment.
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.
Contributor
CI Development Pipeline Status✅ Pipeline: Completed successfully. View Run Details |
d9db492 to
a14e65d
Compare
Contributor
CI Development Pipeline Status✅ Pipeline: Completed successfully. View Run Details |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
docs/scripts/gen_ref_pages.pyutilizingmkdocs-gen-filesandmkdocs-literate-navto automatically generate deep API reference pages for all source code.mikeversion provider inmkdocs.ymlto correctly display the documentation version dropdown.tests/README.mdto document the project's testing tiers, architecture, and requiredpytestmarkers.DocumentationURL link topyproject.toml.pytestmarkers, removed hardcoded template configs inmkdocs.yml, and updated GitHub Action workflows for proper versioning.0.1.2.Type of Change
README.md,SUPPORT.md, docstrings, etc.)Test Plan
hatch run docs:buildand verify that the API reference pages and SUMMARY.md are correctly generated in the output site without errors.hatch run test:allto ensure no tests are broken by the test marker removals inpyproject.toml.tests/README.mdrenders correctly and clearly outlines test guidelines.Related Issues
Screenshots / Visuals (if applicable)
(N/A)
Use of AI
## 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.gitversioned.