Skip to content

feat: add typing, docs deploy workflow, and logger typing#5

Merged
extinctCoder merged 3 commits intomainfrom
sas-branch-7
Aug 18, 2025
Merged

feat: add typing, docs deploy workflow, and logger typing#5
extinctCoder merged 3 commits intomainfrom
sas-branch-7

Conversation

@extinctCoder
Copy link
Copy Markdown
Owner

  • 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.

Sabbir Ahmed Shourov 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
@extinctCoder extinctCoder merged commit cae3d82 into main Aug 18, 2025
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.

1 participant