docs: Fix warnings and update CLI documentation#60
Merged
Conversation
This commit addresses all documentation warnings and updates the CLI documentation to be complete and up-to-date. ## Documentation Warnings Fixed ### Docstring Formatting - Fixed field_factory.py module docstring indentation ### Broken Cross-Reference Links - enumerations.rst: protocol/control_commands → protocol/quick_reference - mqtt_diagnostics.rst: Fixed incorrect absolute paths to relative paths - /docs/DEVICE_STATUS_FIELDS → ../protocol/device_status - /docs/MQTT_CLIENT → ../python_api/mqtt_client - cli.rst: ../guides/mqtt_basics → ../guides/auto_recovery - models.rst: Removed non-existent constants reference ### JSON Syntax Issues - Removed invalid [...] and ... tokens from JSON code blocks in: - cli.rst: Fixed by_day field - mqtt_protocol.rst: Fixed status response and feature response examples ### Duplicate Enum Documentation - Added :no-index: to 17 autoclass directives in enumerations.rst ### Re-export Duplicate Warnings - Added custom logging filter in docs/conf.py to suppress duplicate object description warnings from re-exported classes ## CLI Documentation Updates ### New Content - Added device-info command documentation (was completely missing) - Added --raw flag documentation for status, info, and device-info commands - Added --month option to energy command for daily breakdown queries - Clarified mutually exclusive options (--months vs --month) ### Improvements - All 19 CLI commands now have complete documentation - All command options are fully documented with descriptions - Added examples for new features ## Build Results - Documentation builds successfully with no critical errors - Only 14 import warnings remain (missing optional CLI dependencies: click, rich) - All originally reported warnings are fixed
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
1 participant
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.
Summary
This PR fixes all documentation warnings and updates the CLI documentation to be complete and up-to-date.
Documentation Warnings Fixed
Docstring Formatting
Broken Cross-Reference Links
protocol/control_commands→protocol/quick_reference/docs/DEVICE_STATUS_FIELDS→../protocol/device_status/docs/MQTT_CLIENT→../python_api/mqtt_client../guides/mqtt_basics→../guides/auto_recoveryconstantsreferenceJSON Syntax Issues
[...]and...tokens from JSON code blocksby_dayfield in energy exampleDuplicate Enum Documentation
:no-index:to 17 autoclass directives in enumerations.rstRe-export Duplicate Warnings
CLI Documentation Updates
New Content
--monthsvs--month)Improvements
Build Results
✓ Documentation builds successfully with no critical errors
✓ All originally reported warnings are fixed
✓ Only 14 import warnings remain (missing optional CLI dependencies: click, rich)
Files Modified