Skip to content

Commit 3e57df6

Browse files
committed
fix: fixed several warnings when building docs
1 parent 8aaf99e commit 3e57df6

File tree

7 files changed

+13
-11
lines changed

7 files changed

+13
-11
lines changed
File renamed without changes.

src/examples/querying-data.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ In a query you start by getting events from a bucket and assign that collection
2525
After that you assign what you want to receive from the request to the RETURN variable.
2626

2727
Magic Variables:
28-
There is a magic variable `__CATEGORIES__` you can use in the web UI's Query Explorer to include your configured categories in your query.
28+
There is a magic variable ``__CATEGORIES__`` you can use in the web UI's Query Explorer to include your configured categories in your query.
2929

3030
Here's an example of using this variable to find all events categorized as "Web Browsing"
3131

@@ -86,7 +86,7 @@ Example fetching raw events from the "aw-watcher-window_" bucket:
8686
This is an example that you can run in a Python to fetch raw events posted by the window watcher.
8787
The scripts sums the time spent on each window title and showcases a data redaction use case.
8888

89-
.. literalinclude:: raw_events.py
90-
89+
.. literalinclude:: raw_events.py
90+
9191

9292
.. TODO `Bucket REST API <./rest.html#get-events>`_

src/examples/writing-watchers.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,5 +69,5 @@ This example will describe how to:
6969

7070
.. literalinclude:: client.rs
7171

72-
It is recommend to follow conventions and use the `aw-watcher-<name>` naming scheme for your watcher.
73-
It is also recommended for watchers to accept a `--testing` flag and a `--port <port>` flag to allow users to specify the port to connect to.
72+
It is recommend to follow conventions and use the ``aw-watcher-<name>`` naming scheme for your watcher.
73+
It is also recommended for watchers to accept a ``--testing`` flag and a ``--port <port>`` flag to allow users to specify the port to connect to.

src/faq.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,9 @@ This is a good idea, any application shouldn't just give that privacy-sensitive
4747
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.
4848

4949
*Solutions:*
50+
5051
- Switch to using X11.
51-
- Try an alternative AFK and window :ref:`watcher <other-watchers>` which supports Wayland.
52+
- Try an alternative AFK and window :ref:`watcher <window-watchers>` which supports Wayland.
5253

5354
You can see the general status of the ability of `getting the active window in Wayland on StackOverflow <https://stackoverflow.com/questions/45465016/how-do-i-get-the-active-window-on-gnome-wayland>`_ or follow `the issue for ActivityWatch tracking the problem <https://github.com/ActivityWatch/activitywatch/issues/92>`_.
5455

src/getting-started.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ Autostart
6363

6464
.. group-tab:: macOS
6565
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).
66-
66+
6767
.. group-tab:: Arch Linux
6868

6969
.. note::
7070
Autostart is set up automatically for Arch Linux by the AUR package, if your desktop environment supports `XDG Autostart <https://wiki.archlinux.org/index.php/XDG_Autostart>`_.
71-
72-
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).
71+
72+
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).
7373

7474
.. group-tab:: Ubuntu
7575

src/remote-server.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,8 @@ Opening the server to the network
6565

6666
.. warning:: This is unsafe! (unless you *really* know what you are doing)
6767

68-
If you decide to not heed our warning, you can open the server to the network by setting the following `configuration`:
68+
If you decide to not heed our warning, you can open the server to the network by setting the following :doc:`configuration`:
6969

70-
.. highlight:: toml
7170
aw-server.toml::
7271

7372
[server]

src/watchers.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ ActivityWatch comes with two watchers enabled by default:
1111
These default watchers are collecting some of the most important data.
1212
But there is more to collect, so here are some other watchers that let you do so.
1313

14+
.. _window-watchers:
15+
1416
Window watchers
1517
---------------
1618

0 commit comments

Comments
 (0)