Commit 4d95e50
committed
Fix: Correct docs generation and GitHub workflow
This commit addresses several issues in the documentation generation process:
1. **`docs/scripts/generate_site_data.py`:**
* Modified to scan actual root-level language directories (e.g., C, Python) instead of a non-existent `code_examples/` directory.
* Updated to fetch Git commit history from the entire repository, providing a more accurate "Recent Activity" feed.
* Removed the unused `code_examples_dir` creation.
2. **`docs/index.html`:**
* Corrected the language details modal to display actual filenames (using `file.name`) instead of `[object Object]`.
* Updated to use language icons provided in `site_data.json` directly, removing the local `languageIcons` map.
3. **`.github/workflows/generate_docs.yml`:**
* Adjusted the `paths` trigger to monitor actual language directories (e.g., `C/**`, `Python/**`) for changes, ensuring the workflow runs when relevant code is updated.
* Removed the unnecessary `pip install pyyaml` step, as the script uses the standard `json` library.
4. **`docs/README.md`:**
* Updated to accurately describe the new behavior of the `generate_site_data.py` script, including how it scans directories and fetches Git history.
These changes ensure that the documentation website accurately reflects the content of the repository and that the generation process is robust and efficient.1 parent 738340d commit 4d95e50
4 files changed
Lines changed: 35 additions & 21 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
9 | 19 | | |
10 | 20 | | |
11 | 21 | | |
| |||
29 | 39 | | |
30 | 40 | | |
31 | 41 | | |
32 | | - | |
| 42 | + | |
33 | 43 | | |
34 | 44 | | |
35 | 45 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
17 | | - | |
18 | | - | |
19 | | - | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
907 | 907 | | |
908 | 908 | | |
909 | 909 | | |
910 | | - | |
| 910 | + | |
911 | 911 | | |
912 | 912 | | |
913 | 913 | | |
| |||
956 | 956 | | |
957 | 957 | | |
958 | 958 | | |
959 | | - | |
| 959 | + | |
960 | 960 | | |
961 | 961 | | |
962 | 962 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| |||
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
73 | | - | |
74 | | - | |
| 73 | + | |
| 74 | + | |
75 | 75 | | |
76 | | - | |
77 | | - | |
78 | | - | |
79 | | - | |
80 | | - | |
81 | | - | |
82 | | - | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
83 | 88 | | |
84 | 89 | | |
85 | 90 | | |
| |||
124 | 129 | | |
125 | 130 | | |
126 | 131 | | |
127 | | - | |
128 | | - | |
129 | | - | |
| 132 | + | |
| 133 | + | |
130 | 134 | | |
131 | 135 | | |
132 | | - | |
| 136 | + | |
133 | 137 | | |
134 | 138 | | |
135 | 139 | | |
| |||
0 commit comments