From 49458181a549a4d7894191707078014f7c26b35c Mon Sep 17 00:00:00 2001 From: Raoul Snyman Date: Thu, 3 Oct 2019 20:01:03 +0000 Subject: [PATCH] Use the documentation Docker image and build a PDF - Use the documentation Docker image - Build PDF - Link to image from manual front page - Fix display tags table - Remove unsupported characters in display tags table --- .gitlab-ci.yml | 14 +++++---- manual/source/display_tags.rst | 54 +++++++++++++++++----------------- manual/source/index.rst | 11 +++++++ 3 files changed, 47 insertions(+), 32 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 383d240..214b303 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,8 +1,4 @@ -image: alpine - -before_script: -- apk --no-cache add make py3-setuptools python3-dev -- python3 -m pip install sphinx sphinx_rtd_theme +image: openlp/documentation pages: stage: deploy @@ -10,6 +6,10 @@ pages: - cd manual - make html - mv build/html/ ../public/ + - make latex + - cd build/latex + - make all-pdf + - mv OpenLP.pdf ../../../public/ artifacts: paths: - public @@ -22,6 +22,10 @@ test: - cd manual - make html - mv build/html/ ../test/ + - make latex + - cd build/latex + - make all-pdf + - mv OpenLP.pdf ../../../test/ artifacts: paths: - test diff --git a/manual/source/display_tags.rst b/manual/source/display_tags.rst index 8ae818d..604d9cc 100644 --- a/manual/source/display_tags.rst +++ b/manual/source/display_tags.rst @@ -144,30 +144,30 @@ each left justified. .. table:: :widths: grid - +----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ - | Description | Tag | Start HTML | End HTML | - +================+=====+=============================================================================================================================+================+ - | Align Left | al | ``
`` | ``
`` | - +----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ - | Align Center | ac | ``
`` | ``
`` | - +----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ - | Align Right | ar | ``
`` | ``
`` | - +----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ - | Font size ˄ | fu | ```` | ```` | - +----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ - | Font size ˅ | fd | ```` | ```` | - +----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ - | Font size 20pt | f20 | ```` | ```` + - +----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ - | Arial |arial| ```` | ```` | - +----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ - | Times New |times| ```` | ```` | - | Roman | | | | - +----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ - | Paragraph with | phg | ``
`` | ``
`` | - | hanging test | | | | - +----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ - | Column left | cl | ``
`` | ``
`` | - +----------------+-----+-----------------------------------------------------------------------------------------------------------------------------+----------------+ + +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+ + | Description | Tag | Start HTML | End HTML | + +=================+=======+=============================================================================================================================+================+ + | Align Left | al | ``
`` | ``
`` | + +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+ + | Align Center | ac | ``
`` | ``
`` | + +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+ + | Align Right | ar | ``
`` | ``
`` | + +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+ + | Big font size | fu | ```` | ```` | + +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+ + | Small font size | fd | ```` | ```` | + +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+ + | Font size 20pt | f20 | ```` | ```` + + +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+ + | Arial | arial | ```` | ```` | + +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+ + | Times New | times | ```` | ```` | + | Roman | | | | + +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+ + | Paragraph with | phg | ``
`` | ``
`` | + | hanging test | | | | + +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+ + | Column left | cl | ``
`` | ``
`` | + +-----------------+-------+-----------------------------------------------------------------------------------------------------------------------------+----------------+ diff --git a/manual/source/index.rst b/manual/source/index.rst index e3003c0..9705480 100644 --- a/manual/source/index.rst +++ b/manual/source/index.rst @@ -5,6 +5,16 @@ The OpenLP User Manual is here to help you learn how to use OpenLP. From install using OpenLP on a regular basis, all the information you need to know is in here. And if you see some of it is missing, please `help us add it`_. +Download This Manual +-------------------- + +You can download this manual as a PDF from here: https://manual.openlp.org/OpenLP.pdf + +To open the downloaded manual, you'll need a PDF reader. On macOS and Linux your computer should already have a PDF +reader. On Windows you'll need to install `SumatraPDF`_. + +If you're reading the downloaded manual, you can get the online version at https://manual.openlp.org + Getting Started With OpenLP --------------------------- @@ -60,3 +70,4 @@ Questions and Troubleshooting troubleshooting .. _help us add it: https://openlp.org/contribute +.. _SumatraPDF: https://www.sumatrapdfreader.org/