f7084ae1e4
Summary: Set up a Jenkins pipeline to build the manual as PDF: * Add a Dockerfile to create a Focal Fossa build environment * Add a Jenkinsfile for the Manual pipeline * Publish the PDF Due to unicode characters in the source, LaTeX fails to build: * Changed the engine to xelatex * Added some LaTeX configurations for the PDF build Ref T109 Test Plan: 1. Setup Jenkins 1.1 Create a new Pipeline 1.1.1 Definition => Pipeline script from SCM 1.1.1 SCM => Git 1.1.1 Repositories => https://phab.lubuntu.me/source/manual/ 1.2. Install plugins 1.2.1 Docker plugin and Docker Pipeline plugin 1.2.2 HTML Publisher plugin 2. Install Docker on the Jenkins server 3. Manually start the job 4. Check, that there is a "Lubuntu Manual" link in the Job view, when the build was successful Reviewers: lynorian, tsimonq2, teward Reviewed By: tsimonq2 Maniphest Tasks: T109 Differential Revision: https://phab.lubuntu.me/D102
Lubuntu Manual Source Code
This is the Lubuntu Manual source code. The concept was derived from the Kubuntu Manual. The master branch of this data is now on LXQt for Lubuntu 18.10+ and if you want code for earlier versions it is on the LXDE branch. For each relase of a distro go to the numerical number of that release such as 19.10. To see what is currently in master manual master branch and to see the current stable version look at stable manual branch . To see what is currently for LTS releseases are hosted at manual lts branch
How it works
The documentation is powered by Sphinx and is written in reStructuredText.
Run the following command to install the needed dependencies:
sudo apt install python3-pip python3-sphinx latexmk texlive texlive-formats-extra arcanist python3-sphinx-rtd-theme python3-sphinx-bootstrap-theme
You can see the options for building the documentation by running make help. You can make the html version by running make html. You can make a pdf version of the lubuntu manual with make latexpdf. If you just want to check for warnings or errors building run make dummy.
Contributing
To contribute to the Lubuntu Manual, you can either create a request on Launchpad, or send patch mail to lubuntu-devel@lists.ubuntu.com and prefix the subject with [Lubuntu Manual Pull Request].
If you really want to learn more about sphinx Lyn Perrine found this pycon video helpful [Carol_Willing-Practical_Sphinx] (https://www.youtube.com/watch?v=0ROZRNZkPS8)
If you want short help on how to format things see StyleGuide.rst in this directory.
License
This work is licensed under a Creative Commons Attribution 4.0 International License. More details can be found here: creative commons attribution license