Bump docs version to 3.0

This commit is contained in:
Tomas Groth 2020-12-17 22:47:28 +01:00
parent 944a91fc9b
commit 2641766ad5
5 changed files with 16 additions and 22 deletions

View File

@ -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.

View File

@ -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
# "<project> v<release> 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

View File

@ -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
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 `<https://get.openlp.org/2.0.5/>`_.
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 `<https://get.openlp.org/2.0.5/>`_.
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?

View File

@ -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

View File

@ -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