Skip to content

Commit c8665ae

Browse files
Add installation page to docs (#856)
Add a dedicated installation guide with a single pip command and link it from the handbook index and quick start introduction.
1 parent b45d85d commit c8665ae

3 files changed

Lines changed: 33 additions & 0 deletions

File tree

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ The Handbook
3131
.. toctree::
3232
:maxdepth: 2
3333

34+
installation
3435
introduction
3536
jobs
3637
filters

docs/source/installation.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. _installation:
2+
3+
Installation
4+
============
5+
6+
For prerequisites and optional dependencies, see :doc:`dependencies`.
7+
8+
Install or upgrade with pip
9+
---------------------------
10+
11+
Use this command for both first-time installs and upgrades:
12+
13+
.. code-block:: bash
14+
15+
python -m pip install --upgrade urlwatch
16+
17+
Verify the installation
18+
-----------------------
19+
20+
Check that urlwatch is on your ``PATH`` and prints a version number:
21+
22+
.. code-block:: bash
23+
24+
urlwatch --version
25+
26+
Next steps
27+
----------
28+
29+
Continue with :doc:`introduction` for the Quick Start and initial
30+
configuration.

docs/source/introduction.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Introduction
77
Quick Start
88
-----------
99

10+
First, install urlwatch by following :doc:`installation`. Once installed:
11+
1012
1. Run ``urlwatch`` once to migrate your old data or start fresh
1113
2. Use ``urlwatch --edit`` to customize jobs and filters (``urls.yaml``)
1214
3. Use ``urlwatch --edit-config`` to customize settings and reporters (``urlwatch.yaml``)

0 commit comments

Comments
 (0)