From 09071992167a3a49ee6c66aa1fcb1d887d78fef1 Mon Sep 17 00:00:00 2001 From: Chris Mayo Date: Sat, 15 Aug 2020 17:00:34 +0100 Subject: [PATCH] Include install.txt and upgrading.txt in Sphinx documentation --- doc/install.txt | 4 ++-- doc/src/index.rst | 4 ++++ doc/src/install.rst | 7 +++++++ doc/src/upgrading.rst | 1 + doc/upgrading.txt | 2 +- 5 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 doc/src/install.rst create mode 100644 doc/src/upgrading.rst diff --git a/doc/install.txt b/doc/install.txt index 583d19b3..3470f823 100644 --- a/doc/install.txt +++ b/doc/install.txt @@ -55,8 +55,8 @@ First, install the required software. ClamAv from https://www.clamav.net/ 7. *Optional, for GNOME proxy setting parsing:* - PyGObject and GIO. - Best installed from your distribution e.g. ``python3-gi`` + PyGObject and GIO. + Best installed from your distribution e.g. ``python3-gi`` 8. *Optional, to run the WSGI web interface:* Apache from https://httpd.apache.org/ diff --git a/doc/src/index.rst b/doc/src/index.rst index 5c45c811..f4844849 100644 --- a/doc/src/index.rst +++ b/doc/src/index.rst @@ -20,6 +20,8 @@ Installation .. code-block:: console $ pip3 install git+https://github.com/linkchecker/linkchecker.git + +See the :doc:`installation document ` for more information. Basic usage ------------ @@ -83,6 +85,8 @@ and test integration. :hidden: faq + install + upgrading man/linkchecker man/linkcheckerrc code/index diff --git a/doc/src/install.rst b/doc/src/install.rst new file mode 100644 index 00000000..010d4917 --- /dev/null +++ b/doc/src/install.rst @@ -0,0 +1,7 @@ +Installation +============ +If you are upgrading from older versions of LinkChecker you should +also read the upgrading documentation stored in :doc:`upgrading`. + +.. include:: ../install.txt + :start-line: 5 diff --git a/doc/src/upgrading.rst b/doc/src/upgrading.rst new file mode 100644 index 00000000..4b40df10 --- /dev/null +++ b/doc/src/upgrading.rst @@ -0,0 +1 @@ +.. include:: ../upgrading.txt diff --git a/doc/upgrading.txt b/doc/upgrading.txt index 8902f5a6..6326c125 100644 --- a/doc/upgrading.txt +++ b/doc/upgrading.txt @@ -1,7 +1,7 @@ Upgrading ========= Migrating from 9.x to 10.0 -------------------------- +-------------------------- Python 3.5 or newer is required. The Python Beautiful Soup package is now required. A C compiler is not needed