From cadf73c6ebc568b67b2a13d72fa28eb07d1dc3b7 Mon Sep 17 00:00:00 2001 From: David Douard <david.douard@sdfa3.org> Date: Mon, 16 Sep 2024 13:44:55 +0200 Subject: [PATCH] Fix the README file to make it usable on pypi One cannot use sphinx specific roles when the README.rst content is used as python package description. --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 8201f52..2f51727 100644 --- a/README.rst +++ b/README.rst @@ -76,7 +76,8 @@ file used by all Software Heritage tools, located by default at The configuration file location is subject to the `XDG Base Directory <https://wiki.archlinux.org/index.php/XDG_Base_Directory>`_ specification as -well as explicitly overridden on the :ref:`command line <swh-scanner-cli>` via the +well as explicitly overridden on the `command line +<https://docs.softwareheritage.org/devel/swh-scanner/cli.html>`_ via the ``-C/--config-file`` flag. The following sub-sections and fields can be used within the ``swh > scanner`` -- GitLab