-
Notifications
You must be signed in to change notification settings - Fork 263
/
README.txt
40 lines (23 loc) · 848 Bytes
/
README.txt
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
This directory supports the creation of the Gcovr User Guide using
sphinx.
The necessary python packages have to be installed, e.g. with pip:
pip install -r requirements.txt
The command
make html
creates the documentation in the folder build/html.
If you're using nox you can alos call:
nox -s doc
This will install the reuirements in a virtual environment and run the make process.
When updating for a new gcovr version,
the screenshots will have to be regenerated.
If you have wkhtmltopdf installed, run
make clean-images
make
Otherwise:
1. delete the examples/*.png files
2. in the examples directory, run
./example_html.sh
3. make screenshots of
examples/example-html.html
examples/example-html-details.example.cpp.html
4. resize the screenshots to a maximum width of 700 pixels