Commit b83091f
committed
[#282]:svarga:docs, move docs/ tree under doxy/ — single Doxygen project root, doxy/docs/ holds all sources + build output
Consolidates everything Doxygen-related under doxy/. The top-level
docs/ directory is gone; its contents move as a single subtree to
doxy/docs/ so the Doxygen project (config + theme + sources + build
output) lives in one place.
Moved (git-rename detected, content unchanged — 44 files):
docs/index.md → doxy/docs/index.md (Doxygen mainpage)
docs/aliases.md → doxy/docs/aliases.md (Doxygen INPUT alias page)
docs/curated/ (18) → doxy/docs/curated/ (I/O + TOPICS axes)
docs/reports/ (19) → doxy/docs/reports/ (project reports tree)
docs/links/ (4) → doxy/docs/links/ (Doxyfile @INCLUDE_PATH)
docs/tags/ (1) → doxy/docs/tags/ (cppreference TAGFILE)
Build output (untracked, .gitignored — not in the rename set):
docs/doxygen/ (490+ generated files) → doxy/docs/doxygen/
Path updates (4 modifications):
doxy/Doxyfile — all `../docs/X` references rewritten to `docs/X`
(Doxyfile sits in doxy/ and docs/ is now its sibling):
OUTPUT_DIRECTORY, WARN_LOGFILE, INPUT, EXCLUDE, USE_MDFILE_AS_MAINPAGE,
TAGFILES, @INCLUDE_PATH
scripts/docs-build.sh — post-process target + final message updated
to doxy/docs/doxygen/html
.github/workflows/docs.yml — three path references:
log=docs/doxygen/warnings.log → doxy/docs/doxygen/warnings.log
path: docs/doxygen/warnings.log → doxy/docs/doxygen/warnings.log
publish_dir: ./docs/doxygen/html → ./doxy/docs/doxygen/html
.gitignore — updated for new build path; dropped two mkdocs-era stale
lines:
docs/docs/site → removed
site/ → removed
docs/doxygen/ → doxy/docs/doxygen/
Side benefit: the `../../../examples/X` cross-references in some
reports (h5cpp-handle-inventory.md, h5cpp-filters-inventory-and-use-guide.md)
were broken after the earlier reports-tree flattening — they assumed
3-level depth. Reports now live 3 levels deep again (doxy/docs/reports/X.md),
so the existing paths resolve correctly without further editing.
Local rebuild via scripts/docs-build.sh is clean (0 warnings); every
key landing page resolves at doxy/docs/doxygen/html/. The development
server is restarted against the new path.1 parent e7de92f commit b83091f
48 files changed
Lines changed: 18 additions & 20 deletions
File tree
- .github/workflows
- doxy
- docs
- curated
- io-api
- file
- topics
- links
- reports
- tags
- scripts
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | | - | |
| 42 | + | |
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| |||
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | | - | |
| 56 | + | |
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
64 | | - | |
| 64 | + | |
65 | 65 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
158 | 158 | | |
159 | 159 | | |
160 | 160 | | |
161 | | - | |
162 | | - | |
163 | | - | |
| 161 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| |||
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
50 | | - | |
| 50 | + | |
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
68 | | - | |
| 68 | + | |
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
| |||
130 | 130 | | |
131 | 131 | | |
132 | 132 | | |
133 | | - | |
| 133 | + | |
134 | 134 | | |
135 | 135 | | |
136 | 136 | | |
| |||
159 | 159 | | |
160 | 160 | | |
161 | 161 | | |
162 | | - | |
| 162 | + | |
163 | 163 | | |
164 | 164 | | |
165 | | - | |
| 165 | + | |
166 | 166 | | |
167 | 167 | | |
168 | 168 | | |
| |||
0 commit comments