Skip to content

Commit f59b514

Browse files
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

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/docs.yml

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,10 @@ permissions:
88
contents: write
99

1010
jobs:
11-
# MkDocs — conceptual docs, architecture pages, guides
12-
deploy-mkdocs:
13-
runs-on: ubuntu-latest
14-
steps:
15-
- name: Checkout repo
16-
uses: actions/checkout@v6
17-
18-
- name: Set up Python
19-
uses: actions/setup-python@v6
20-
with:
21-
python-version: '3.x'
22-
23-
- name: Install MkDocs + Material theme
24-
run: pip install mkdocs mkdocs-material
25-
26-
- name: Build MkDocs site
27-
run: mkdocs build
28-
29-
- name: Deploy MkDocs to gh-pages root
30-
uses: peaceiris/actions-gh-pages@v4
31-
with:
32-
github_token: ${{ secrets.GITHUB_TOKEN }}
33-
publish_dir: ./site
34-
keep_files: true
35-
36-
# Doxygen — API reference generated from C++ headers
11+
# Doxygen — full project documentation site (API reference + curated
12+
# I/O+TOPICS axes + COOKBOOK + REPORTS, all generated from headers,
13+
# examples, and the docs/{index,aliases,curated,reports}/ markdown).
14+
# Publishes to the gh-pages root; MkDocs has been retired.
3715
deploy-doxygen:
3816
runs-on: ubuntu-latest
3917
steps:
@@ -55,7 +33,7 @@ jobs:
5533
# version-deriving git describe in docs-build.sh sees real releases.
5634
git fetch --tags --depth=0 origin || true
5735
58-
- name: Build Doxygen API reference (version from git tag, post-processed)
36+
- name: Build Doxygen documentation (version from git tag, post-processed)
5937
run: scripts/docs-build.sh
6038

6139
- name: Summarise Doxygen warnings
@@ -79,10 +57,9 @@ jobs:
7957
if-no-files-found: ignore
8058
retention-days: 30
8159

82-
- name: Deploy Doxygen to gh-pages/api
60+
- name: Deploy Doxygen to gh-pages root
8361
uses: peaceiris/actions-gh-pages@v4
8462
with:
8563
github_token: ${{ secrets.GITHUB_TOKEN }}
8664
publish_dir: ./docs/doxygen/html
87-
destination_dir: api
8865
keep_files: true

CMakeLists.txt

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -453,25 +453,8 @@ string(TOLOWER "${CPACK_PACKAGE_FILE_NAME}" CPACK_PACKAGE_FILE_NAME)
453453
include(CPack)
454454

455455
# ─── Developer convenience targets ───────────────────────────────────────────
456-
find_program(MKDOCS_EXECUTABLE mkdocs)
457456
find_program(DOXYGEN_EXECUTABLE doxygen)
458457

459-
if(MKDOCS_EXECUTABLE)
460-
add_custom_target(docs COMMAND ${MKDOCS_EXECUTABLE} build --config-file ${CMAKE_SOURCE_DIR}/mkdocs.yml --site-dir ${CMAKE_BINARY_DIR}/site
461-
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
462-
COMMENT "Building MkDocs documentation → build/site"
463-
VERBATIM
464-
)
465-
set(MKDOCS_DEV_ADDR "127.0.0.1:8000" CACHE STRING "host:port for mkdocs serve (docs-serve target)")
466-
add_custom_target(docs-serve COMMAND ${MKDOCS_EXECUTABLE} serve --livereload
467-
--dev-addr ${MKDOCS_DEV_ADDR}
468-
--config-file ${CMAKE_SOURCE_DIR}/mkdocs.yml
469-
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
470-
COMMENT "Serving MkDocs with live reload at ${MKDOCS_DEV_ADDR} (Ctrl-C to stop)"
471-
VERBATIM
472-
)
473-
endif()
474-
475458
if(DOXYGEN_EXECUTABLE)
476459
add_custom_target(docs-doxygen COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
477460
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doxy

docs/architecture-core.md

Lines changed: 0 additions & 113 deletions
This file was deleted.

0 commit comments

Comments
 (0)