You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+98Lines changed: 98 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,3 +15,101 @@ The current build logs of the documentation can be found in [Github Actions](htt
15
15
### Broken links
16
16
17
17
Detail of broken links in the doc can be found in the build logs. Select a build in Github Action "Deploy", then "Usage". Click on "build" and expand again the "Build line". Search for "WARNING".
18
+
19
+
## Building Documentation Locally
20
+
21
+
You can build the documentation locally on your computer to preview changes before committing them.
22
+
23
+
### Prerequisites
24
+
25
+
Ensure Python 3.8+ is installed on your system. Install the required dependencies from the root of the repository:
26
+
27
+
```console
28
+
pip install -r requirements.txt
29
+
```
30
+
31
+
### Building
32
+
33
+
Build the English documentation:
34
+
35
+
```console
36
+
cd docs/EN
37
+
sphinx-build -M html . _build
38
+
```
39
+
40
+
The built documentation will be in `docs/EN/_build/html/`. Open `index.html` in your browser to view it.
41
+
42
+
To build a different language (e.g., Czech):
43
+
44
+
```console
45
+
cd docs/CROWDIN/cs
46
+
sphinx-build -M html . _build
47
+
```
48
+
49
+
## Quality Check Utility
50
+
51
+
The `qualitycheck.py` script in the `utils/` folder validates the documentation for common issues like broken links, missing images, and orphaned files.
52
+
53
+
### Basic Usage
54
+
55
+
Check the English documentation:
56
+
57
+
```console
58
+
python utils/qualitycheck.py
59
+
```
60
+
61
+
Check a specific language (e.g., Czech):
62
+
63
+
```console
64
+
python utils/qualitycheck.py --lang cs
65
+
```
66
+
67
+
Check all languages (English + all CROWDIN translations):
68
+
69
+
```console
70
+
python utils/qualitycheck.py --lang all
71
+
```
72
+
73
+
### Available Options
74
+
75
+
-`--lang <code>` - Language selector (default: `EN`). Use CROWDIN language codes like `cs`, `de`, `fr`, or `all` for all languages.
0 commit comments