Skip to content

docs: enhance documentation with API reference and mkdocstrings integration #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
kozo2 merged 1 commit into from
Sep 1, 2025
Merged

docs: enhance documentation with API reference and mkdocstrings integration #34

kozo2 merged 1 commit into from
Sep 1, 2025

Conversation

@kozo2
Copy link
Contributor

@kozo2 kozo2 commented Sep 1, 2025 •
edited
Loading

No description provided.

Copilot AI review requested due to automatic review settings September 1, 2025 08:35
Copilot AI reviewed Sep 1, 2025
View reviewed changes
Copy link

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 enhances the documentation system by integrating mkdocstrings for automated API reference generation. It adds comprehensive API documentation structure for the Hatch package manager with auto-generated documentation from Python docstrings.

  • Adds mkdocstrings integration with Google-style docstring parsing
  • Creates comprehensive API reference section with 16 documentation pages
  • Configures optional documentation dependencies in pyproject.toml

Reviewed Changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated no comments.

File Description
pyproject.toml Adds optional documentation dependencies for mkdocs and mkdocstrings
mkdocs.yml Configures mkdocstrings plugin and adds API reference navigation structure
docs/articles/api/*.md Creates API documentation pages for core modules and installers using mkdocstrings

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@kozo2 kozo2 merged commit e19714e into dev Sep 1, 2025
@kozo2 kozo2 deleted the dev-mkdocstrings branch September 1, 2025 08:36
LittleCoinCoin pushed a commit that referenced this pull request Sep 8, 2025
@kozo2
docs: enhance documentation with API reference and mkdocstrings integ…
34a8fa2 
…ration (#34)
cracking-shells-semantic-release bot pushed a commit that referenced this pull request Sep 8, 2025
@semantic-release-bot
chore(release): 1.0.0-dev.1 [skip ci]
67cb82a 
## [1.0.0-dev.1](v0.6.2...v1.0.0-dev.1) (2025-09-08)

### ⚠ BREAKING CHANGES

* Replace custom dual-file versioning system with semantic-release.
All future commits must follow Conventional Commits format.

- Remove custom versioning scripts (300+ lines eliminated)
- Remove VERSION and VERSION.meta files
- Remove custom GitHub Actions workflows
- Add semantic-release configuration and workflows
- Add commitizen for guided commit messages
- Add commitlint for PR validation
- Update pyproject.toml to static versioning
- Update documentation for new workflow

This migration eliminates complex custom code and adopts industry-standard
automated versioning practices consistent with the CrackingShells organization.

### ci

* migrate to semantic-release ([cec8e28](cec8e28))

### Documentation

* enable Python requirements installation for documentation build ([#35](#35)) ([ba03817](ba03817))
* enhance documentation with API reference and mkdocstrings integration ([#34](#34)) ([34a8fa2](34a8fa2))
* update documentation theme to Material and add mkdocs-material dependency ([#36](#36)) ([20825d8](20825d8))
cracking-shells-semantic-release bot pushed a commit that referenced this pull request Sep 16, 2025
@semantic-release-bot
chore(release): 1.0.0-dev.1 [skip ci]
969daa0 
## [1.0.0-dev.1](v0.6.2...v1.0.0-dev.1) (2025-09-16)

### ⚠ BREAKING CHANGES

* Replace custom dual-file versioning system with semantic-release.
All future commits must follow Conventional Commits format.

- Remove custom versioning scripts (300+ lines eliminated)
- Remove VERSION and VERSION.meta files
- Remove custom GitHub Actions workflows
- Add semantic-release configuration and workflows
- Add commitizen for guided commit messages
- Add commitlint for PR validation
- Update pyproject.toml to static versioning
- Update documentation for new workflow

This migration eliminates complex custom code and adopts industry-standard
automated versioning practices consistent with the CrackingShells organization.

### ci

* migrate to semantic-release ([cec8e28](cec8e28))

### Features

* add wobble decorators to test_docker_installer.py ([fb01ac2](fb01ac2))
* add wobble decorators to test_env_manip.py ([90dbdb1](90dbdb1))
* add wobble decorators to test_online_package_loader.py ([3e2c3e5](3e2c3e5))
* add wobble decorators to test_python_environment_manager.py ([cf4e068](cf4e068))
* add wobble decorators to test_registry_retriever.py ([51f414e](51f414e))
* add wobble decorators to test_system_installer.py ([4bdcab4](4bdcab4))
* complete wobble test categorization ([0a37786](0a37786))
* implement self-contained test data architecture with 15 core packages ([3341b54](3341b54))

### Bug Fixes

* add missing wobble decorators to remaining test files ([e63ca0c](e63ca0c))
* add required scope parameters to integration test decorators ([0dc4a01](0dc4a01))
* correct wobble integration_test decorator usage ([0214d13](0214d13))
* migrate failing tests to use self-contained test packages ([2d10458](2d10458))
* resolve critical test failures in architecture migration ([abe707e](abe707e))

### Documentation

* add mkdocs-print-site-plugin ([#37](#37)) ([1b11cae](1b11cae))
* enable Python requirements installation for documentation build ([#35](#35)) ([ba03817](ba03817))
* enhance documentation with API reference and mkdocstrings integration ([#34](#34)) ([34a8fa2](34a8fa2))
* update documentation theme to Material and add mkdocs-material dependency ([#36](#36)) ([20825d8](20825d8))

### Code Refactoring

* eliminate redundant dynamic test package generation ([b1ff860](b1ff860))
* remove sys.path.insert statements from test files ([25a2d37](25a2d37))
cracking-shells-semantic-release bot pushed a commit that referenced this pull request Sep 16, 2025
@semantic-release-bot
chore(release): 0.7.0-dev.1 [skip ci]
b2c5ead 
## [0.7.0-dev.1](v0.6.2...v0.7.0-dev.1) (2025-09-16)

### Features

* add wobble decorators to test_docker_installer.py ([79850bf](79850bf))
* add wobble decorators to test_env_manip.py ([154da89](154da89))
* add wobble decorators to test_online_package_loader.py ([3fc0491](3fc0491))
* add wobble decorators to test_python_environment_manager.py ([666a425](666a425))
* add wobble decorators to test_registry_retriever.py ([c2ba4f7](c2ba4f7))
* add wobble decorators to test_system_installer.py ([8a96092](8a96092))
* complete wobble test categorization ([13bc4fa](13bc4fa))
* implement self-contained test data architecture with 15 core packages ([219e1c2](219e1c2))

### Bug Fixes

* add missing wobble decorators to remaining test files ([c640af9](c640af9))
* add required scope parameters to integration test decorators ([9610353](9610353))
* correct wobble integration_test decorator usage ([efbf3e1](efbf3e1))
* migrate failing tests to use self-contained test packages ([780cf69](780cf69))
* resolve critical test failures in architecture migration ([ec2a7a3](ec2a7a3))

### Documentation

* add mkdocs-print-site-plugin ([#37](#37)) ([0d79770](0d79770))
* enable Python requirements installation for documentation build ([#35](#35)) ([ba03817](ba03817))
* enhance documentation with API reference and mkdocstrings integration ([#34](#34)) ([34a8fa2](34a8fa2))
* update documentation theme to Material and add mkdocs-material dependency ([#36](#36)) ([20825d8](20825d8))

### Code Refactoring

* eliminate redundant dynamic test package generation ([82d5622](82d5622))
* remove sys.path.insert statements from test files ([3c4744f](3c4744f))
LittleCoinCoin pushed a commit that referenced this pull request Sep 16, 2025
@kozo2
docs: enhance documentation with API reference and mkdocstrings integ…
b99c964 
…ration (#34)
cracking-shells-semantic-release bot pushed a commit that referenced this pull request Sep 16, 2025
@semantic-release-bot
chore(release): 0.7.0-dev.1 [skip ci]
c2c57ac 
## [0.7.0-dev.1](v0.6.2...v0.7.0-dev.1) (2025-09-16)

### Features

* add wobble decorators to test_docker_installer.py ([66740f8](66740f8))
* add wobble decorators to test_env_manip.py ([ec6e0a2](ec6e0a2))
* add wobble decorators to test_online_package_loader.py ([34b8173](34b8173))
* add wobble decorators to test_python_environment_manager.py ([251b0d8](251b0d8))
* add wobble decorators to test_registry_retriever.py ([0bc43fe](0bc43fe))
* add wobble decorators to test_system_installer.py ([26707b5](26707b5))
* complete wobble test categorization ([5a11d45](5a11d45))
* implement self-contained test data architecture with 15 core packages ([c7a2fae](c7a2fae))

### Bug Fixes

* add missing wobble decorators to remaining test files ([e3a1c92](e3a1c92))
* add required scope parameters to integration test decorators ([ca9cf65](ca9cf65))
* correct wobble integration_test decorator usage ([faf3344](faf3344))
* migrate failing tests to use self-contained test packages ([33c5782](33c5782))
* resolve critical test failures in architecture migration ([c3c3575](c3c3575))

### Documentation

* add mkdocs-print-site-plugin ([#37](#37)) ([dd86960](dd86960))
* enable code copy feature in mkdocs.yml ([300c114](300c114))
* enable Python requirements installation for documentation build ([#35](#35)) ([ea53013](ea53013))
* enhance documentation with API reference and mkdocstrings integration ([#34](#34)) ([b99c964](b99c964))
* moving from GitHub Pages to Read The Docs ([#32](#32)) ([9b7dd07](9b7dd07))
* update documentation theme to Material and add mkdocs-material dependency ([#36](#36)) ([5fd9a40](5fd9a40))

### Code Refactoring

* eliminate redundant dynamic test package generation ([f497c09](f497c09))
* remove sys.path.insert statements from test files ([41c291e](41c291e))
cracking-shells-semantic-release bot pushed a commit that referenced this pull request Sep 17, 2025
@semantic-release-bot
chore(release): 0.7.0-dev.1 [skip ci]
4223e55 
## [0.7.0-dev.1](v0.6.2...v0.7.0-dev.1) (2025-09-17)

### Features

* add centralized test data infrastructure for non-TTY testing ([a704937](a704937))
* add non-TTY handling to dependency installation orchestrator ([ee63d6e](ee63d6e))
* add wobble decorators to test_docker_installer.py ([66740f8](66740f8))
* add wobble decorators to test_env_manip.py ([ec6e0a2](ec6e0a2))
* add wobble decorators to test_online_package_loader.py ([34b8173](34b8173))
* add wobble decorators to test_python_environment_manager.py ([251b0d8](251b0d8))
* add wobble decorators to test_registry_retriever.py ([0bc43fe](0bc43fe))
* add wobble decorators to test_system_installer.py ([26707b5](26707b5))
* complete wobble test categorization ([5a11d45](5a11d45))
* implement self-contained test data architecture with 15 core packages ([c7a2fae](c7a2fae))

### Bug Fixes

* add missing wobble decorators to remaining test files ([e3a1c92](e3a1c92))
* add required scope parameters to integration test decorators ([ca9cf65](ca9cf65))
* correct wobble integration_test decorator usage ([faf3344](faf3344))
* migrate failing tests to use self-contained test packages ([33c5782](33c5782))
* resolve critical test failures in architecture migration ([c3c3575](c3c3575))

### Documentation

* add comprehensive documentation for non-TTY handling ([65c1efb](65c1efb))
* add mkdocs-print-site-plugin ([#37](#37)) ([dd86960](dd86960))
* enable code copy feature in mkdocs.yml ([300c114](300c114))
* enable Python requirements installation for documentation build ([#35](#35)) ([ea53013](ea53013))
* enhance documentation with API reference and mkdocstrings integration ([#34](#34)) ([b99c964](b99c964))
* moving from GitHub Pages to Read The Docs ([#32](#32)) ([9b7dd07](9b7dd07))
* update documentation theme to Material and add mkdocs-material dependency ([#36](#36)) ([5fd9a40](5fd9a40))

### Code Refactoring

* eliminate redundant dynamic test package generation ([f497c09](f497c09))
* remove sys.path.insert statements from test files ([41c291e](41c291e))
cracking-shells-semantic-release bot pushed a commit that referenced this pull request Sep 18, 2025
@semantic-release-bot
chore(release): 0.7.0-dev.1 [skip ci]
fb3f979 
## [0.7.0-dev.1](v0.6.2...v0.7.0-dev.1) (2025-09-18)

### Features

* add centralized test data infrastructure for non-TTY testing ([a704937](a704937))
* add non-TTY handling to dependency installation orchestrator ([ee63d6e](ee63d6e))
* add wobble decorators to test_docker_installer.py ([66740f8](66740f8))
* add wobble decorators to test_env_manip.py ([ec6e0a2](ec6e0a2))
* add wobble decorators to test_online_package_loader.py ([34b8173](34b8173))
* add wobble decorators to test_python_environment_manager.py ([251b0d8](251b0d8))
* add wobble decorators to test_registry_retriever.py ([0bc43fe](0bc43fe))
* add wobble decorators to test_system_installer.py ([26707b5](26707b5))
* complete wobble test categorization ([5a11d45](5a11d45))
* implement self-contained test data architecture with 15 core packages ([c7a2fae](c7a2fae))

### Bug Fixes

* add missing wobble decorators to remaining test files ([e3a1c92](e3a1c92))
* add required scope parameters to integration test decorators ([ca9cf65](ca9cf65))
* correct wobble integration_test decorator usage ([faf3344](faf3344))
* migrate failing tests to use self-contained test packages ([33c5782](33c5782))
* resolve critical test failures in architecture migration ([c3c3575](c3c3575))

### Documentation

* add comprehensive documentation for non-TTY handling ([65c1efb](65c1efb))
* add mkdocs-print-site-plugin ([#37](#37)) ([dd86960](dd86960))
* enable code copy feature in mkdocs.yml ([300c114](300c114))
* enable Python requirements installation for documentation build ([#35](#35)) ([ea53013](ea53013))
* enhance documentation with API reference and mkdocstrings integration ([#34](#34)) ([b99c964](b99c964))
* moving from GitHub Pages to Read The Docs ([#32](#32)) ([9b7dd07](9b7dd07))
* update documentation theme to Material and add mkdocs-material dependency ([#36](#36)) ([5fd9a40](5fd9a40))

### Code Refactoring

* eliminate redundant dynamic test package generation ([f497c09](f497c09))
* remove sys.path.insert statements from test files ([41c291e](41c291e))
cracking-shells-semantic-release bot pushed a commit that referenced this pull request Sep 18, 2025
@semantic-release-bot
chore(release): 0.7.0 [skip ci]
d25fd9a 
## [0.7.0](v0.6.2...v0.7.0) (2025-09-18)

### Features

* add centralized test data infrastructure for non-TTY testing ([a704937](a704937))
* add non-TTY handling to dependency installation orchestrator ([ee63d6e](ee63d6e))
* add wobble decorators to test_docker_installer.py ([66740f8](66740f8))
* add wobble decorators to test_env_manip.py ([ec6e0a2](ec6e0a2))
* add wobble decorators to test_online_package_loader.py ([34b8173](34b8173))
* add wobble decorators to test_python_environment_manager.py ([251b0d8](251b0d8))
* add wobble decorators to test_registry_retriever.py ([0bc43fe](0bc43fe))
* add wobble decorators to test_system_installer.py ([26707b5](26707b5))
* complete wobble test categorization ([5a11d45](5a11d45))
* implement self-contained test data architecture with 15 core packages ([c7a2fae](c7a2fae))

### Bug Fixes

* add missing wobble decorators to remaining test files ([e3a1c92](e3a1c92))
* add required scope parameters to integration test decorators ([ca9cf65](ca9cf65))
* correct wobble integration_test decorator usage ([faf3344](faf3344))
* migrate failing tests to use self-contained test packages ([33c5782](33c5782))
* resolve critical test failures in architecture migration ([c3c3575](c3c3575))

### Documentation

* add comprehensive documentation for non-TTY handling ([65c1efb](65c1efb))
* add mkdocs-print-site-plugin ([#37](#37)) ([dd86960](dd86960))
* enable code copy feature in mkdocs.yml ([300c114](300c114))
* enable Python requirements installation for documentation build ([#35](#35)) ([ea53013](ea53013))
* enhance documentation with API reference and mkdocstrings integration ([#34](#34)) ([b99c964](b99c964))
* moving from GitHub Pages to Read The Docs ([#32](#32)) ([9b7dd07](9b7dd07))
* update documentation theme to Material and add mkdocs-material dependency ([#36](#36)) ([5fd9a40](5fd9a40))

### Code Refactoring

* eliminate redundant dynamic test package generation ([f497c09](f497c09))
* remove sys.path.insert statements from test files ([41c291e](41c291e))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@kozo2