feat: add documentations with mkdocs #25
Merged
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.
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 usingmkdocstrings
.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.