Skip to content

CLI reference page has no aw-qt section #208

Description

@Gabriel-Dalton

src/cli.rst has a .. click:: aw_qt.main:main directive, but the published page (https://docs.activitywatch.net/en/latest/cli.html) only shows aw-client. aw-qt isn't in the docs dependencies in pyproject.toml, so I assume sphinx-click can't import it during the build.

That leaves aw-qt --profile without a reference, although directories.rst and getting-started.rst both mention it.

I didn't open a PR because I'm not sure which way you'd want it: add aw-qt to the docs build, or move it under "Not yet documented". I can do either.

Activity

  1. TimeToBuildBob commented on Oct 7, 2026

    @TimeToBuildBob
    Contributor

    Confirmed: pyproject.toml pins aw-core/aw-server/aw-client as git deps but not aw-qt, so sphinx-click can't import aw_qt.main and silently drops that section.

    Preferred fix: add aw-qt = {git = "https://github.com/ActivityWatch/aw-qt.git", rev = "master"} next to the other three so the existing .. click:: directive renders — same pattern, no hand-maintained copy to drift. If the PyQt6 pull makes the RTD build too heavy or fail, fall back to a hand-written aw-qt section with --profile, --autostart-modules, etc. A PR for the dependency route is welcome; include a build log snippet showing the section rendering.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions