You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
build: add aw-qt so the CLI reference renders its section - #209
The CLI reference has a .. click:: aw_qt.main:main directive, but aw-qt was not installed for the docs build, so sphinx-click could not import it and the section was dropped.
Changes:
Add aw-qt as a git dependency alongside aw-core, aw-server and aw-client.
Narrow the Python range to >=3.11,<3.14. aw-qt requires <3.14 and Poetry will not lock without it. Read the Docs builds on 3.13.
Mock PyQt6 for sphinx-click. aw_qt.main imports PyQt6.QtCore at module level, and PyQt6 is in an optional group in aw-qt, so it is not installed. Mocking keeps Qt out of the docs build.
Re-lock. aw-qt needs aw-core ^0.5.18 and the lock pinned 0.5.17, so this also moves aw-core to 0.5.18, aw-client to 0.5.15 and aw-server from 0.13.2 to 0.14.0. The API reference will be built from those versions.
Build log before:
src/cli.rst:13: ERROR: Failed to import "main" from "aw_qt.main". The following exception was raised:
ModuleNotFoundError: No module named 'PyQt6'
After, the section renders with these anchors in cli.html:
The new section adds two warnings: a duplicate aw-qt autosectionlabel (same as the existing one for aw-client), and an unresolved reference from the backticked none in the --autostart-modules help text in aw-qt.
Locally verified 314e5d7 against current master (3f07123) in separate Python 3.13 environments: master drops the section with No module named 'aw_qt'; this head passes poetry check --lock and make html, and cli.html contains all eight aw-qt option anchors, including --profile. PyQt6 is absent, so the mock is doing the intended job. The aw-client section still renders.
Recommendation: merge this head; no carry needed. One caveat beyond the two disclosed CLI warnings: the aw-core refresh adds two non-fatal Unexpected indentation docstring errors (merge_subwatcher_fields and q2_merge_subwatcher_fields). The build exits 0, but is not warning/error-clean. Those formatting diagnostics do not invalidate the restored CLI reference; I would not expand this fix into general docs-warning cleanup. Thanks for following through on #208.
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
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.
The CLI reference has a
.. click:: aw_qt.main:maindirective, but aw-qt was not installed for the docs build, so sphinx-click could not import it and the section was dropped.Changes:
>=3.11,<3.14. aw-qt requires<3.14and Poetry will not lock without it. Read the Docs builds on 3.13.aw_qt.mainimportsPyQt6.QtCoreat module level, and PyQt6 is in an optional group in aw-qt, so it is not installed. Mocking keeps Qt out of the docs build.Build log before:
After, the section renders with these anchors in
cli.html:The new section adds two warnings: a duplicate
aw-qtautosectionlabel (same as the existing one foraw-client), and an unresolved reference from the backtickednonein the--autostart-moduleshelp text in aw-qt.Closes #208