From 2641766ad5bdae8dd3db6f4de0f2e0d92460acc5 Mon Sep 17 00:00:00 2001 From: Tomas Groth Date: Thu, 17 Dec 2020 22:47:28 +0100 Subject: [PATCH] Bump docs version to 3.0 --- api/source/index.rst | 2 +- manual/source/conf.py | 6 +++--- manual/source/faq.rst | 18 +++++++++--------- manual/source/install_linux.rst | 4 ++-- manual/source/troubleshooting.rst | 8 +------- 5 files changed, 16 insertions(+), 22 deletions(-) diff --git a/api/source/index.rst b/api/source/index.rst index dc42497..5de5baf 100644 --- a/api/source/index.rst +++ b/api/source/index.rst @@ -6,7 +6,7 @@ Welcome ======= -Welcome to the OpenLP 2.4 API Documentation! In here you will find all +Welcome to the OpenLP 3.0 API Documentation! In here you will find all information relating to OpenLP's core classes, core plugins, and anything else deemed necessary or interesting by the developers. diff --git a/manual/source/conf.py b/manual/source/conf.py index 70fefdb..4ee359d 100644 --- a/manual/source/conf.py +++ b/manual/source/conf.py @@ -49,9 +49,9 @@ copyright = u'OpenLP Developers' # built documents. # # The short X.Y version. -version = '2.4' +version = '3.0' # The full version, including alpha/beta/rc tags. -release = '2.4' +release = '3.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -110,7 +110,7 @@ html_theme_path = [os.path.abspath(os.path.join('..', '..', 'common', 'themes')) # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -html_title = u'OpenLP 2.4 Reference Manual' +html_title = u'OpenLP 3.0 Reference Manual' # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None diff --git a/manual/source/faq.rst b/manual/source/faq.rst index 5c24f79..80cfac4 100644 --- a/manual/source/faq.rst +++ b/manual/source/faq.rst @@ -57,26 +57,26 @@ Upgrading It is always a good idea to make a backup when prompted by OpenLP. -Can I upgrade from any 1.9.x or 2.0.x release to 2.4? +Can I upgrade from any 1.9.x or 2.0.x release to 3.0? ----------------------------------------------------- -No, you should first upgrade to the last stable release in the 2.0-series (2.0.5) and then upgrade to 2.4 to ensure -that data is correctly converted. You can download OpenLP 2.0.5 from ``_. +No, you should first upgrade to the last stable release in the 2.0-series (2.0.5) and then upgrade to 3.0 to ensure +that data is correctly converted. You can download OpenLP 2.0.5 from ``_. -Can I upgrade directly from 1.2 to 2.4? +Can I upgrade directly from 1.2 to 3.0? --------------------------------------- -No, you will have to install 2.0.5 first, then import the 1.2 data and then upgrade to 2.4. See the 2.0 documentation +No, you will have to install 2.0.5 first, then import the 1.2 data and then upgrade to 3.0. See the 2.0 documentation for how to upgrade from 1.2 to 2.0. You can download OpenLP 2.0.5 from ``_. -Does 2.4 replace older 2.x versions, or can they be run side by side? +Does 3.0 replace older 2.x versions, or can they be run side by side? --------------------------------------------------------------------- -OpenLP 2.4 and earlier 2.x versions cannot run side by side. When running 2.4 for first time any existing 2.x data will -automatically be converted to the 2.4 format. OpenLP 2.4 will ask if it should make a backup on startup, which can be +OpenLP 3.0 and earlier 2.x versions cannot run side by side. When running 3.0 for first time any existing 2.x data will +automatically be converted to the 3.0 format. OpenLP 3.0 will ask if it should make a backup on startup, which can be used in case you want to downgrade again. -OpenLP 2.4 cannot read service files created by OpenLP 2.0.4 and earlier, it can only read service files created by +OpenLP 3.0 cannot read service files created by OpenLP 2.0.4 and earlier, it can only read service files created by OpenLP 2.0.5 and higher. Where can I download an older version of OpenLP? diff --git a/manual/source/install_linux.rst b/manual/source/install_linux.rst index b4318f7..398f2f8 100644 --- a/manual/source/install_linux.rst +++ b/manual/source/install_linux.rst @@ -13,9 +13,9 @@ Installation of OpenLP on Ubuntu can either be done through the Software Center or the command line. Command line instructions will be included at the end of this section on Ubuntu and its variants. -OpenLP 2.4 supports Ubuntu 14.04 or later versions. There is currently an older +OpenLP 3.0 supports Ubuntu 18.04 or later versions. There is currently an older version of OpenLP available in the official Ubuntu repositories, which can be -found using the Software Center, but to get OpenLP 2.4 it is necessary to add +found using the Software Center, but to get OpenLP 3.0 it is necessary to add the OpenLP Personal Package Archive (PPA) to your system. Ubuntu, Ubuntu GNOME, Xubuntu diff --git a/manual/source/troubleshooting.rst b/manual/source/troubleshooting.rst index bf5bf0b..e7e0057 100644 --- a/manual/source/troubleshooting.rst +++ b/manual/source/troubleshooting.rst @@ -77,7 +77,7 @@ the link to the page that is created. Windows ^^^^^^^ -Find the OpenLP 2.4 folder in your Start menu. Choose the "OpenLP (Debug)" option. +Find the OpenLP 3.0 folder in your Start menu. Choose the "OpenLP (Debug)" option. OpenLP will start up in Debug mode and save the log file. To get to the log file folder on Windows, press the Windows Key and "R" at the same time. This will open the @@ -367,12 +367,6 @@ monitor resolution and avoiding shadows and outline text will help. We are hoping a future release of the toolkit we are using (QtWebKit) will help improve this, but there is no timeframe at present. -Why do live backgrounds not work in OpenLP 2.4 on Windows and macOS -------------------------------------------------------------------- - -Due to issues in one of the underlying frameworks that OpenLP uses (Qt5), -live backgrounds do not work in OpenLP 2.4. We aim to fix this in OpenLP 2.6. - Downgrade guide (how to restore a backup) ----------------------------------------- In some cases new versions of OpenLP can contain bugs that was not discovered