Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ sphinx-tabs = "^3.4"
sphinx-click = ">=6.0"
myst-parser = ">=2.0"
sphinxext-rediraffe = "^0.2.7"
sphinxext-opengraph = ">=0.9"

[build-system]
requires = ["poetry-core"]
Expand Down
23 changes: 13 additions & 10 deletions src/badges.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,40 +20,43 @@
<br>

<a href="https://github.com/ActivityWatch/activitywatch/actions?query=branch%3Amaster">
<img title="Build Status GitHub" src="https://github.com/ActivityWatch/activitywatch/actions/workflows/test.yml/badge.svg?branch=master" />
<img title="Build Status GitHub" alt="Build status" src="https://github.com/ActivityWatch/activitywatch/actions/workflows/release.yml/badge.svg?branch=master" />
</a>
<a href="http://docs.activitywatch.net">
<img title="Documentation" src="https://readthedocs.org/projects/activitywatch/badge/?version=latest" />
<a href="https://docs.activitywatch.net">
<img title="Documentation" alt="Documentation status" src="https://readthedocs.org/projects/activitywatch/badge/?version=latest" />
</a>

<br>

<a href="https://github.com/ActivityWatch/activitywatch/releases">
<img title="Latest release" src="https://img.shields.io/github/release-pre/ActivityWatch/activitywatch.svg">
<img title="Latest release" alt="Latest release" src="https://img.shields.io/github/release-pre/ActivityWatch/activitywatch.svg">
</a>
<a href="https://github.com/ActivityWatch/activitywatch/releases">
<img title="Total downloads (GitHub Releases)" src="https://img.shields.io/github/downloads/ActivityWatch/activitywatch/total.svg" />
<img title="Total downloads (GitHub Releases)" alt="Total downloads" src="https://img.shields.io/github/downloads/ActivityWatch/activitywatch/total.svg" />
</a>
<a href="https://discord.gg/vDskV9q">
<img title="Discord" src="https://img.shields.io/discord/755040852727955476" />
<img title="Discord" alt="Discord" src="https://img.shields.io/discord/755040852727955476" />
</a>

<br>

<a href="https://activitywatch.net/go/?src=docs">
<img title="Support ActivityWatch Pro" alt="Support ActivityWatch Pro" src="https://img.shields.io/badge/support-ActivityWatch%20Pro-orange.svg" />
</a>
<a href="https://activitywatch.net/donate/">
<img title="Donated" src="https://img.shields.io/badge/budget-%24201%2Fmo%20from%2040%20supporters-orange.svg" />
<img title="Donate" alt="Donate one-off" src="https://img.shields.io/badge/donate-one--off-orange.svg" />
</a>
<a href="https://doi.org/10.5281/zenodo.4957165">
<img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4957165.svg" />
<img title="DOI" alt="DOI 10.5281/zenodo.4957165" src="https://zenodo.org/badge/DOI/10.5281/zenodo.4957165.svg" />
</a>

<br>

<a href="https://twitter.com/ActivityWatchIt">
<img title="Twitter follow" src="https://img.shields.io/twitter/follow/ActivityWatchIt.svg?style=social&label=Follow"/>
<img title="Twitter follow" alt="Follow @ActivityWatchIt" src="https://img.shields.io/twitter/follow/ActivityWatchIt.svg?style=social&label=Follow"/>
</a>
<a href="https://github.com/ActivityWatch/activitywatch">
<img title="Star on GitHub" src="https://img.shields.io/github/stars/ActivityWatch/activitywatch.svg?style=social&label=Star">
<img title="Star on GitHub" alt="Star on GitHub" src="https://img.shields.io/github/stars/ActivityWatch/activitywatch.svg?style=social&label=Star">
</a>

<br>
Expand Down
8 changes: 8 additions & 0 deletions src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
"sphinx_click",
"sphinxext.rediraffe",
"sphinxcontrib.jquery",
"sphinxext.opengraph",
]

extlinks = {
Expand Down Expand Up @@ -82,6 +83,13 @@
copyright = f"2016-{date.today().year} {author_copyright}"
description_short = "The free and open source automated time-tracker"

# OpenGraph and <meta name="description"> tags for link previews.
# On Read the Docs, og:url is derived from READTHEDOCS_CANONICAL_URL.
ogp_site_name = project
ogp_image = "https://activitywatch.net/img/banner.png"
ogp_image_alt = f"{project}: {description_short}"
ogp_social_cards = {"enable": False}

# TODO: Automatically detect version (possibly using git tags)
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down
5 changes: 5 additions & 0 deletions src/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
:og:description: Documentation for ActivityWatch, the free and open source automated time-tracker: installation, configuration, watchers, syncing, the REST API and more.

.. meta::
:description: Documentation for ActivityWatch, the free and open source automated time-tracker: installation, configuration, watchers, syncing, the REST API and more.

.. image:: ../media/banners/banner.png

.. include:: badges.rst
Expand Down
Loading