File: README-qdoc.md

package info (click to toggle)
ktextaddons 1.9.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 17,856 kB
  • sloc: cpp: 62,045; ansic: 6,520; xml: 2,630; sh: 11; makefile: 7
file content (40 lines) | stat: -rw-r--r-- 714 bytes parent folder | download
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
# Generate doc

## Dependencies

We need to clone kde-qdoc-common

```bash
cd <kde path>
git clone https://invent.kde.org/sdk/kde-qdoc-common
```

## Environment variables

set in `.bashrc`

```bash
export KDE_DOCS=<kde path>/kde-qdoc-common
```

We need to define where we generate doc:

```bash
export GENERATE_DOCDIR=<kde path>/generate-docs
```

## CMakePreset.json

For generating doc we have a target in CMakePreset.json

```bash
cmake --preset generate-doc

cmake --build --preset generate-doc
```

we can show result in `$GENERATE_DOCDIR/`

## Porting info

[Streamlined Application Development Experience #10](https://invent.kde.org/teams/goals/streamlined-application-development-experience/-/issues/10)