diff --git a/src/conf.py b/src/conf.py index 4d6a151..26f7e52 100644 --- a/src/conf.py +++ b/src/conf.py @@ -183,6 +183,15 @@ html_theme_options = {"collapse_navigation": False, "navigation_depth": 4} using_rtd_theme = True + # Enable "Edit on GitHub" links (fixes #158) + html_context = { + "display_github": True, + "github_user": "ActivityWatch", + "github_repo": "docs", + "github_version": "master", + "conf_py_path": "/src/", + } + # The name for this set of Sphinx documents. # " v documentation" by default. # diff --git a/src/directories.rst b/src/directories.rst index f6e42fc..5b397a3 100644 --- a/src/directories.rst +++ b/src/directories.rst @@ -1,41 +1,50 @@ Directories =========== -Where things get stored depends on the platform you're using. All paths should follow standard directories on their platforms, and to accomplish this we use `appdirs `_ in Python code and `appdirs-rs `_ in Rust code. +Where things get stored depends on the platform you're using. All paths should follow standard directories on their platforms, and to accomplish this we use `appdirs `_ in Python code and the `dirs `_ crate in Rust code. + +Each ActivityWatch component stores its data in a subdirectory named after itself. + +The paths below use ``aw-server-rust`` as an example component. .. _data-directory: Data ---- -- Windows: ``C:\Users\\AppData\Local\activitywatch\activitywatch`` -- macOS: ``~/Library/Application\ Support/activitywatch`` -- Linux: ``~/.local/share/activitywatch`` +This is where the SQLite database and other persistent data is stored. + +- Windows: ``C:\Users\\AppData\Local\activitywatch\aw-server-rust`` +- macOS: ``~/Library/Application Support/activitywatch/aw-server-rust`` +- Linux: ``~/.local/share/activitywatch/aw-server-rust`` .. _config-directory: Config ------ +Configuration files for each component. + +- Windows: ``C:\Users\\AppData\Local\activitywatch\aw-server-rust`` +- macOS: ``~/Library/Application Support/activitywatch/aw-server-rust`` +- Linux: ``~/.config/activitywatch/aw-server-rust``, or the path defined by the :code:`$XDG_CONFIG_HOME` environment variable. -- Windows: ``%LocalAppData%\activitywatch\activitywatch`` -- macOS: ``~/Library/Application\ Support/activitywatch/`` -- Linux: ``~/.config/activitywatch``, or the path defined by the :code:`$XDG_CONFIG_HOME` environment variable. +Other components have their own config directories, e.g. ``aw-watcher-afk``, ``aw-watcher-window``. .. _logs-directory: Logs ---- -- Windows: ``C:\Users\\AppData\Local\activitywatch\activitywatch`` -- macOS: ``~/Library/Logs/activitywatch`` -- Linux: ``~/.cache/activitywatch/log`` +- Windows: ``C:\Users\\AppData\Local\activitywatch\aw-server-rust\logs`` +- macOS: ``~/Library/Logs/activitywatch/aw-server-rust`` +- Linux: ``~/.cache/activitywatch/log/aw-server-rust`` .. _cache-directory: Cache ----- -- Windows: TODO -- macOS: TODO -- Linux: ``~/.cache/activitywatch`` +- Windows: ``C:\Users\\AppData\Local\activitywatch\aw-server-rust\cache`` +- macOS: ``~/Library/Caches/activitywatch/aw-server-rust`` +- Linux: ``~/.cache/activitywatch/aw-server-rust``