1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
Principal:
pdfBuild.py allows to create a pdf from a collection of issues created within invent.kde.org, the kde gitlab environment.
Working with gitlab and its issues fonctionnality allows to provide the team with an environment to collaborate while working on a specification. Comments can be used and old designs are stored for logging purpose.
Using pdfBuild.py ensures to always have the latest specification.
Packages and modules to install in order to run pdfBuild.py:
- pdflaxtex
on debian based distribution:
sudo apt install texlive-latex-extra
- pylatex
using pip:
pip install pylatex
-git
How it works:
pdfBuild.py first extracts the pdf structure from the following invent wiki page:
https://invent.kde.org/education/gcompris/-/wikis/GComprisCPSpec/gcompris-control-panel-specification
The structure is provided by a list of wiki links pointing to issues:
example:
- [Main screen overview](https://invent.kde.org/education/gcompris/-/issues/3)
- [Connecting devices](https://invent.kde.org/education/gcompris/-/issues/5)
- [Following results](https://invent.kde.org/education/gcompris/-/issues/6)
In this example the first link points to the invent issue number 3. This one contains the text to be displayed in the final pdf specification and its illustrations.
Illustrations are stored into the corresponding issues and are uploaded and updated directly within the issues interface.
In order to get the wiki content, the scipt is using git to download the file https://invent.kde.org/education/gcompris.wiki.git .
bugs:
It is sometimes necessary to run the script twice to avoid the following file reading error:
FileNotFoundError: [Errno 2] No such file or directory: './gcompris.wiki/GComprisCPSpec/GCompris-control-panel-specification.md'
The second time git will correctly download the required files.
This bug needs to be investigated
Usage:
python pdfBuild.py --wikiurl https://invent.kde.org/education/gcompris.wiki.git --outputFilename myGCSpecificationFile.pdflatex
additional options to save build time:
--doNotDownloadWiki (to use the wiki file already downloaded locally)
--doNotDownloadIssuesImages (to use the image files from issues already downloaded locally)
Improvements:
Output files should be generated in a dedicated output directory.
|
