Update docs
This commit is contained in:
@@ -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.
|
generated. It requires the following Python packages on Debian and Ubuntu.
|
||||||
|
|
||||||
* ``python3-sphinx``
|
* ``python3-sphinx``
|
||||||
|
* ``python3-sphinx-rtd-theme``
|
||||||
* ``python3-sphinxcontrib.qthelp``
|
* ``python3-sphinxcontrib.qthelp``
|
||||||
|
|
||||||
Or from PyPi:
|
Or from PyPi:
|
||||||
|
|
||||||
.. code-block:: console
|
.. 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:
|
The documentation can then be built from the ``docs`` folder in the source code by running:
|
||||||
|
|
||||||
|
|||||||
@@ -95,3 +95,16 @@ all users, run the script with the ``sudo`` command.
|
|||||||
|
|
||||||
.. tip::
|
.. tip::
|
||||||
All options of the setup script can be listed with: ``./setup.py help``.
|
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.
|
||||||
|
|||||||
@@ -46,5 +46,6 @@ install.
|
|||||||
|
|
||||||
`xdg-install` – Install launcher and icons for freedesktop systems. Run as root
|
`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.
|
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.
|
`win-install` – Install desktop and start menu icons for Windows systems.
|
||||||
|
|||||||
Reference in New Issue
Block a user