Commit f59b514
committed
[#282]:svarga:docs, retire MkDocs — drop config, top-level pages, theme dirs, build/CI targets; Doxygen publishes to gh-pages root
Removes the MkDocs configuration and all Material-theme remnants now
that the Doxygen tree (front page + I/O + TOPICS + COOKBOOK + USABILITY +
REPORTS, with the curated reports tree) is the single documentation source.
Top-level config:
- mkdocs.yml
docs/ top-level Markdown pages (none referenced from docs/index.md or
the Doxygen INPUT list):
- architecture.md + architecture-{core,io,types,integration,parallelism}.md
- compiler.md, cpp-standard-compliance-report.md, design.md
- examples.md, filtering-pipeline-rework-report.md
- s3.md, stl.md, thirdparty.md, workflow.md
docs/ subdirs (mkdocs/Material only — confirmed not in Doxyfile INPUT):
- overrides/ (Material custom_dir, 6 files)
- assets/ (Material assets, 12 files)
- styles/ (MkDocs CSS, 8 files)
- javascripts/ (MkDocs JS, 8 files)
- icons/ (Material icons, 22 files)
- dot/ (2 files — Doxygen has its own DOT integration)
- skills/ (7 .md files)
- examples/ (5 .md files — Doxygen EXCLUDEs this dir)
Kept (all currently consumed by Doxygen):
- docs/index.md — USE_MDFILE_AS_MAINPAGE target
- docs/aliases.md — INPUT-listed alias-vocabulary page
- docs/curated/ — I/O + TOPICS tree
- docs/reports/ — flat reports tree
- docs/links/ — Doxyfile @INCLUDE_PATH
- docs/tags/ — Doxyfile TAGFILES (cppreference cross-refs)
- docs/pix/ — Doxyfile IMAGE_PATH
- docs/doxygen/ — build output
CMakeLists.txt: drop find_program(MKDOCS_EXECUTABLE) block + the
'docs' (mkdocs build) and 'docs-serve' (mkdocs serve --livereload)
custom targets. docs-doxygen target preserved.
.github/workflows/docs.yml: drop the entire deploy-mkdocs job (Python
setup, pip install mkdocs+material, mkdocs build, deploy ./site).
The remaining deploy-doxygen job now publishes to the gh-pages
root (destination_dir removed) instead of /api, so the Doxygen site
takes over the URL that MkDocs used to serve.
Net diff: 88 files / -15,593 / +6. Local rebuild via scripts/docs-build.sh
is clean (0 warnings); every key landing page still resolves
(curated_io_api, curated_topics, reports_index, USABILITY, REPORTS).1 parent ab9ae92 commit f59b514
88 files changed
Lines changed: 6 additions & 15593 deletions
File tree
- .github/workflows
- docs
- assets
- dot
- examples
- icons
- javascripts
- overrides
- .icons
- partials
- skills
- styles
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 | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 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 | | - | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
37 | 15 | | |
38 | 16 | | |
39 | 17 | | |
| |||
55 | 33 | | |
56 | 34 | | |
57 | 35 | | |
58 | | - | |
| 36 | + | |
59 | 37 | | |
60 | 38 | | |
61 | 39 | | |
| |||
79 | 57 | | |
80 | 58 | | |
81 | 59 | | |
82 | | - | |
| 60 | + | |
83 | 61 | | |
84 | 62 | | |
85 | 63 | | |
86 | 64 | | |
87 | | - | |
88 | 65 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
453 | 453 | | |
454 | 454 | | |
455 | 455 | | |
456 | | - | |
457 | 456 | | |
458 | 457 | | |
459 | | - | |
460 | | - | |
461 | | - | |
462 | | - | |
463 | | - | |
464 | | - | |
465 | | - | |
466 | | - | |
467 | | - | |
468 | | - | |
469 | | - | |
470 | | - | |
471 | | - | |
472 | | - | |
473 | | - | |
474 | | - | |
475 | 458 | | |
476 | 459 | | |
477 | 460 | | |
| |||
This file was deleted.
0 commit comments