From 96fb892465e8f964b662715f9406c88b17a232f0 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Fri, 2 Apr 2021 16:13:18 +0200 Subject: [PATCH] Update docs --- docs/source/int_started.rst | 3 ++- docs/source/setup_linux.rst | 13 +++++++++++++ setup/README.md | 1 + 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/source/int_started.rst b/docs/source/int_started.rst index 385f99fc4..28609c713 100644 --- a/docs/source/int_started.rst +++ b/docs/source/int_started.rst @@ -109,13 +109,14 @@ you're running novelWriter from the source code, a local copy of this documentat generated. It requires the following Python packages on Debian and Ubuntu. * ``python3-sphinx`` +* ``python3-sphinx-rtd-theme`` * ``python3-sphinxcontrib.qthelp`` Or from PyPi: .. code-block:: console - pip install sphinx sphinxcontrib-qthelp + pip install sphinx sphinx-rtd-theme sphinxcontrib-qthelp The documentation can then be built from the ``docs`` folder in the source code by running: diff --git a/docs/source/setup_linux.rst b/docs/source/setup_linux.rst index 7ce99afa4..cf3ee5802 100644 --- a/docs/source/setup_linux.rst +++ b/docs/source/setup_linux.rst @@ -95,3 +95,16 @@ all users, run the script with the ``sudo`` command. .. tip:: All options of the setup script can be listed with: ``./setup.py help``. + + +Uninstalling Icons +================== + +The steps taken by the ``xdg-install`` step can be reversed by running: + +.. code-block:: console + + ./setup.py xdg-uninstall + +This will remove the desktop launcher and icons from the system. As above, whether this is done on +the current user, or system wide, depends on whether this command is called with ``sudo`` or not. diff --git a/setup/README.md b/setup/README.md index 66bfb548c..a2c3f163f 100644 --- a/setup/README.md +++ b/setup/README.md @@ -46,5 +46,6 @@ install. `xdg-install` – Install launcher and icons for freedesktop systems. Run as root or with sudo for system-wide install, or as user for single user install. +Running `xdg-uninstall` will remove the icons. `win-install` – Install desktop and start menu icons for Windows systems.