feat: add typing, docs deploy workflow, and logger typing#5
Merged
extinctCoder merged 3 commits intomainfrom Aug 18, 2025
Merged
feat: add typing, docs deploy workflow, and logger typing#5extinctCoder merged 3 commits intomainfrom
extinctCoder merged 3 commits intomainfrom
Conversation
added 3 commits
August 18, 2025 08:18
- Add precise type annotations to MQTT callbacks and station handler (mqtt_client.on_connect/on_disconnect and station_simulator __handle_control) to improve static checking and readability. - Add typing imports in relevant modules (Any, LogRecord) and annotate logger setup/getter to return Logger and accept typed level. - Create GitHub Actions workflow docs.yml to deploy MkDocs to gh-pages, enabling CI-triggered documentation deployment on push or manual dispatch. - Enhance mkdocs.yml with project metadata (repo_url, author, site_url, theme fonts) and docs site configuration. - Replace placeholder docs/README.md with a project-specific overview and key features for better project documentation. These changes improve code quality through typing, and add automated documentation deployment and more useful documentation metadata.
- Add MkDocs config and requirements for documentation - Add API docs for power station simulator modules - Update codebook.toml with new terms - Rewrite README with MkDocs usage and project layout - Refactor station_simulator.py with docstrings and comments - Move and expand mqtt_client.py with improved documentation - Remove .env and legacy simulator/config/logger/main modules
- Rewrite README with simulator overview and features - Add project metadata to mkdocs.yml - Improve logger type hints and docstrings
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.
(mqtt_client.on_connect/on_disconnect and station_simulator
__handle_control) to improve static checking and readability.
logger setup/getter to return Logger and accept typed level.
enabling CI-triggered documentation deployment on push or manual
dispatch.
theme fonts) and docs site configuration.
and key features for better project documentation.
These changes improve code quality through typing, and add automated
documentation deployment and more useful documentation metadata.