Commit b8128f4
[#282]:svarga:docs, flatten reports tree + curated I/O+TOPICS axis + top-level REPORTS nav + v1.12.6 accuracy pass
Reorganises the Doxygen documentation tree into a 4-axis structure
(I/O / TOPICS / COOKBOOK / USABILITY) with REPORTS as a fifth top-level
tab, and reconciles every architecture / inventory / taxonomy report
against h5cpp v1.12.6's actual implementation state.
Layout (doxy/DoxygenLayout.xml):
- I/O axis: FILE (h5::create, h5::open) / DATASET / ATTRIBUTES / GROUPS
- TOPICS axis: PROPERTIES / LINEAR ALGEBRA / STL / REFLECTION / FILTERS /
MPI / ERROR / TYPESYSTEM / CDASH (no longer carries REPORTS as a child)
- COOKBOOK: 28 example READMEs unchanged
- USABILITY: top-level link at reports_usability_evaluation
- REPORTS: new top-level tab, links to reports_index
Reports tree flattened (docs/reports/{architecture,compatibility,inventories,
project,surveys,taxonomies}/ -> docs/reports/). 15 files renamed via git
rename detection; the 6 subdirectory index.md files removed. New
docs/reports/index.md groups the 18 reports thematically: Architecture &
Design / Inventories & Guides / Compiler Attribute Taxonomies / Surveys
& Comparisons / Project Assessment.
Doxyfile (doxy/Doxyfile):
- USE_MDFILE_AS_MAINPAGE: ../README.md -> ../docs/index.md
- INPUT: drop ../README.md, add ../docs/index.md + ../docs/curated
- EXCLUDE_SYMBOLS: add h5::impl::*, h5::error::*, h5::pod, h5::strlen,
h5::has_scatter, h5::gorilla, h5::uniform, h5::normal, h5::exponential,
h5::bernoulli — keeps the error-leaf hierarchy out of the nav tree
Curated tree (docs/curated/) — new:
- io-api/{index,file,dataset,attributes,groups}.md + io-api/file/{create,open}.md
- topics/{index,properties,linalg,stl,reflection,filters,mpi,error,
typesystem,cdash,architecture}.md
- Reflection page carries the fully-decorated [[h5::*]] worked example
+ the generated H5T_COMPOUND / scatter / gather code expansion
Front page (docs/index.md): purpose-built Doxygen landing distinct from
README.md — hero pitch + 10-line snippet, comparison table vs direct
HDF5 in C/C++, 3-axis nav, capability matrix, single combined install
table with H5CPP + COMPILER columns and reference-style links, project
status with badges, acknowledgements, project info.
v1.12.6 accuracy pass — reviewed and updated against actual code:
- h5cpp-type-system-map.md: complex<T> gate is HDF5 >= 2.0 (not 1.16);
enum support qualified as H5CPP_REGISTER_DATATYPE-only; compiler
attribute list reduced to what h5cpp-compiler actually parses
([[h5::alias]] and [[h5::version]] removed — not implemented today).
Fixed smart-quote-inside-backtick rendering bug in section 16
(was breaking the entire Unsupported-by-design table).
- h5cpp-type-system-architecture-notes.md: reframed from "prototype
working-tree bank as of 2026-05-26" to "v1.12.6 (released)";
storage_representation enum extended with Winston-model additions
(array_element / array_dataset / fls_dataset / fixed_length_string);
"current bank" / "current session" temporal markers replaced.
- h5cpp-handle-inventory.md: "14 property-list variants" -> 16;
async typedef range 353-359 -> 353-358; "remaining 8" -> 10;
ROS3 build break documented as resolved via H5FD_CURR_ROS3_FAPL_T_VERSION
gate.
- h5cpp-compiler-multi-backend-architecture.md: rewritten — was
speculative ("tier-2 on AI roadmap"), now reflects 11 backends
shipped (hdf5/protobuf/json/msgpack/cbor/bson/avro/rlp/sql ×3
dialects). Attribute namespaces corrected to flat top-level
([[pb::*]] / [[json::*]] / etc, NOT nested h5::proto::* / h5::json::*).
CMake helper documented as supporting hdf5 | protocol-buffers only.
- h5cpp-threaded-pipeline-sigma-queue-design.md: superseded-status
banner — actual implementation shipped as pool_pipeline_t with
std::future + std::async (no sigma queue dependency).
- h5cpp-usability-evaluation.md: 84 yellow stars + 21 white stars
replaced with monochrome ●/○ scorecard; complex<T> field names
{re,im} -> {r,i}; enum class and opaque types corrected from
not-supported to supported-via-H5CPP_REGISTER_DATATYPE.
New report: h5cpp-multithreading-pipeline-state.md — current state of
the filter pipeline at v1.12.6, covering both the h5::high_throughput
DAPL path and the h5::append packet-table path through pt_t. Documents
the three orthogonal pieces (FAPL worker pool / DAPL flag /
pool_pipeline_t), the cross-path behaviour matrix, back-pressure policy,
honest limitations list, and a profiling recipe.
[#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).
[#282]:svarga:docs, drop docs/pix/ (unreferenced) + tidy Doxyfile IMAGE_PATH + EXCLUDE
The docs/pix/ tree carried 14 image files (gifs / pngs / svgs / a jpg
or two) from the MkDocs era — financial_eng.jpg, steve-varga.jpg,
perf-{armadillo,stl,struct}.png, sparse-csr.svg, julia-sparse-mat.png,
matrix-base.svg, meta.svg, two other.svg variants, FF-IH_File{Group,Object}.gif,
c-strings-inmemory.png.
Verified unreferenced before removal:
- 0 markdown `` image links anywhere in docs/
- 0 Doxygen `@image` / `\image` directives in source
- 0 references from kept-input files (docs/index.md, docs/aliases.md,
docs/curated/, docs/reports/, h5cpp/, examples/, doxy/)
- 0 images copied into the rendered docs/doxygen/html/ output by
the previous build
Doxyfile tidied alongside:
- IMAGE_PATH = ../docs/pix → removed (target no longer exists)
- EXCLUDE list trimmed to just `../docs/doxygen` — the seven mkdocs-era
EXCLUDE entries (overrides / assets / styles / javascripts / dot /
icons / pix / examples) all pointed at directories that were deleted
in the MkDocs retirement commit and are dead config.
Local rebuild via scripts/docs-build.sh is clean (0 warnings); every
key landing page still resolves.
[#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 94d992b commit b8128f4
180 files changed
Lines changed: 4624 additions & 31379 deletions
File tree
- .github/workflows
- docs
- assets
- dot
- examples
- icons
- javascripts
- overrides
- .icons
- partials
- pix
- reports
- architecture
- compatibility
- inventories
- project
- surveys
- taxonomies
- skills
- styles
- 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 | |
|---|---|---|---|
| |||
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 | | |
62 | 40 | | |
63 | 41 | | |
64 | | - | |
| 42 | + | |
65 | 43 | | |
66 | 44 | | |
67 | 45 | | |
| |||
75 | 53 | | |
76 | 54 | | |
77 | 55 | | |
78 | | - | |
| 56 | + | |
79 | 57 | | |
80 | 58 | | |
81 | 59 | | |
82 | | - | |
| 60 | + | |
83 | 61 | | |
84 | 62 | | |
85 | 63 | | |
86 | | - | |
87 | | - | |
| 64 | + | |
88 | 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 | |
|---|---|---|---|
| |||
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