diff --git a/src/examples/cargo.toml b/src/examples/Cargo.toml similarity index 100% rename from src/examples/cargo.toml rename to src/examples/Cargo.toml diff --git a/src/examples/querying-data.rst b/src/examples/querying-data.rst index a060dc1..2652ae9 100644 --- a/src/examples/querying-data.rst +++ b/src/examples/querying-data.rst @@ -25,7 +25,7 @@ In a query you start by getting events from a bucket and assign that collection After that you assign what you want to receive from the request to the RETURN variable. Magic Variables: - There is a magic variable `__CATEGORIES__` you can use in the web UI's Query Explorer to include your configured categories in your query. + There is a magic variable ``__CATEGORIES__`` you can use in the web UI's Query Explorer to include your configured categories in your query. Here's an example of using this variable to find all events categorized as "Web Browsing" @@ -86,7 +86,7 @@ Example fetching raw events from the "aw-watcher-window_" bucket: This is an example that you can run in a Python to fetch raw events posted by the window watcher. The scripts sums the time spent on each window title and showcases a data redaction use case. - .. literalinclude:: raw_events.py - + .. literalinclude:: raw_events.py + .. TODO `Bucket REST API <./rest.html#get-events>`_ diff --git a/src/examples/writing-watchers.rst b/src/examples/writing-watchers.rst index 3613232..928518f 100644 --- a/src/examples/writing-watchers.rst +++ b/src/examples/writing-watchers.rst @@ -69,5 +69,5 @@ This example will describe how to: .. literalinclude:: client.rs -It is recommend to follow conventions and use the `aw-watcher-` naming scheme for your watcher. -It is also recommended for watchers to accept a `--testing` flag and a `--port ` flag to allow users to specify the port to connect to. +It is recommend to follow conventions and use the ``aw-watcher-`` naming scheme for your watcher. +It is also recommended for watchers to accept a ``--testing`` flag and a ``--port `` flag to allow users to specify the port to connect to. diff --git a/src/faq.rst b/src/faq.rst index d02fe02..12f86c6 100644 --- a/src/faq.rst +++ b/src/faq.rst @@ -47,8 +47,9 @@ This is a good idea, any application shouldn't just give that privacy-sensitive Unfortunately, in Wayland compositors like Gnome's Mutter there is no way at all to get the current window, this leaves the window watcher completely disabled in Wayland. *Solutions:* + - Switch to using X11. -- Try an alternative AFK and window :ref:`watcher ` which supports Wayland. +- Try an alternative AFK and window :ref:`watcher ` which supports Wayland. You can see the general status of the ability of `getting the active window in Wayland on StackOverflow `_ or follow `the issue for ActivityWatch tracking the problem `_. diff --git a/src/getting-started.rst b/src/getting-started.rst index 559f994..5e67a12 100644 --- a/src/getting-started.rst +++ b/src/getting-started.rst @@ -63,13 +63,13 @@ Autostart .. group-tab:: macOS You can automatically start ActivityWatch when you log in by [adding it to your Login Items](https://support.apple.com/guide/mac-help/open-items-automatically-when-you-log-in-mh15189/mac). - + .. group-tab:: Arch Linux .. note:: Autostart is set up automatically for Arch Linux by the AUR package, if your desktop environment supports `XDG Autostart `_. - - You can set up autostart in other environments by adding [`dex`](https://archlinux.org/packages/extra/any/dex/) (to enable XDG autostart) or simply `aw-qt` to whatever place you put your startup applications (i3 config, etc). + + You can set up autostart in other environments by adding [``dex``](https://archlinux.org/packages/extra/any/dex/) (to enable XDG autostart) or simply ``aw-qt`` to whatever place you put your startup applications (i3 config, etc). .. group-tab:: Ubuntu diff --git a/src/remote-server.rst b/src/remote-server.rst index 9d8730b..ab249cf 100644 --- a/src/remote-server.rst +++ b/src/remote-server.rst @@ -65,9 +65,8 @@ Opening the server to the network .. warning:: This is unsafe! (unless you *really* know what you are doing) -If you decide to not heed our warning, you can open the server to the network by setting the following `configuration`: +If you decide to not heed our warning, you can open the server to the network by setting the following :doc:`configuration`: -.. highlight:: toml aw-server.toml:: [server] diff --git a/src/watchers.rst b/src/watchers.rst index db463fd..e24eec5 100644 --- a/src/watchers.rst +++ b/src/watchers.rst @@ -11,6 +11,8 @@ ActivityWatch comes with two watchers enabled by default: These default watchers are collecting some of the most important data. But there is more to collect, so here are some other watchers that let you do so. +.. _window-watchers: + Window watchers ---------------