Skip to content
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.

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

feat: add documentations with mkdocs #25

Merged
merged 2 commits into from
Jan 31, 2025
Merged

feat: add documentations with mkdocs #25

merged 2 commits into from
Jan 31, 2025

Conversation

hudsonbrendon
Copy link
Owner

This pull request introduces several changes to enhance the documentation and setup for the Python Solar Plus Intelbras project. The most important changes include adding badges to the README.md, setting up documentation with MkDocs, and updating dependencies.

Enhancements to documentation and setup:

  • README.md: Added badges for Python package status, Dependabot updates, and GitHub Pages build status. Included installation instructions, usage examples, features list, and contribution guidelines.
  • docs/index.md: Created a documentation index with auto-generated API documentation using mkdocstrings.
  • mkdocs.yml: Configured MkDocs with the Material theme, custom fonts, and various markdown extensions to improve the documentation site.

Dependency updates:

  • pyproject.toml: Added dependencies for MkDocs, MkDocs Material theme, pymdown-extensions, and mkdocstrings to support the new documentation setup.

@hudsonbrendon hudsonbrendon merged commit 56e6f46 into main Jan 31, 2025
7 checks passed
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