Skip to content

Commit b83091f

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

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: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ permissions:
1010
jobs:
1111
# Doxygen — full project documentation site (API reference + curated
1212
# I/O+TOPICS axes + COOKBOOK + REPORTS, all generated from headers,
13-
# examples, and the docs/{index,aliases,curated,reports}/ markdown).
13+
# examples, and the doxy/docs/{index,aliases,curated,reports}/ markdown).
1414
# Publishes to the gh-pages root; MkDocs has been retired.
1515
deploy-doxygen:
1616
runs-on: ubuntu-latest
@@ -39,7 +39,7 @@ jobs:
3939
- name: Summarise Doxygen warnings
4040
if: always()
4141
run: |
42-
log=docs/doxygen/warnings.log
42+
log=doxy/docs/doxygen/warnings.log
4343
if [[ -f $log ]]; then
4444
count=$(wc -l < $log)
4545
echo "::notice::Doxygen warnings: $count lines (see uploaded artifact 'doxygen-warnings')"
@@ -53,13 +53,13 @@ jobs:
5353
uses: actions/upload-artifact@v4
5454
with:
5555
name: doxygen-warnings
56-
path: docs/doxygen/warnings.log
56+
path: doxy/docs/doxygen/warnings.log
5757
if-no-files-found: ignore
5858
retention-days: 30
5959

6060
- name: Deploy Doxygen to gh-pages root
6161
uses: peaceiris/actions-gh-pages@v4
6262
with:
6363
github_token: ${{ secrets.GITHUB_TOKEN }}
64-
publish_dir: ./docs/doxygen/html
64+
publish_dir: ./doxy/docs/doxygen/html
6565
keep_files: true

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,4 @@ data/
158158
# =============================================================================
159159
# Documentation build output
160160
# =============================================================================
161-
docs/docs/site
162-
site/
163-
docs/doxygen/
161+
doxy/docs/doxygen/

doxy/Doxyfile

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Doxyfile 1.9.x — H5CPP API reference
22
# Run from the doxy/ directory: doxygen Doxyfile
3-
# Output lands in ../docs/doxygen/html/ (separate from MkDocs site/)
3+
# Output lands in docs/doxygen/html/ (separate from MkDocs site/)
44

55
DOXYFILE_ENCODING = UTF-8
66
PROJECT_NAME = H5CPP
@@ -12,7 +12,7 @@ PROJECT_NAME = H5CPP
1212
PROJECT_NUMBER = $(H5CPP_DOXYGEN_VERSION)
1313
PROJECT_BRIEF = "Modern C++ templates for HDF5 serial and parallel I/O"
1414
PROJECT_LOGO =
15-
OUTPUT_DIRECTORY = ../docs/doxygen
15+
OUTPUT_DIRECTORY = docs/doxygen
1616
CREATE_SUBDIRS = NO
1717
ALLOW_UNICODE_NAMES = NO
1818
OUTPUT_LANGUAGE = English
@@ -47,25 +47,25 @@ WARN_NO_PARAMDOC = NO
4747
# Emit warnings into a logfile alongside stderr so CI can upload it as an
4848
# artifact for coverage-tracking visibility. The file lives in the build dir
4949
# so it's picked up by the workflow's actions/upload-artifact step.
50-
WARN_LOGFILE = ../docs/doxygen/warnings.log
50+
WARN_LOGFILE = docs/doxygen/warnings.log
5151

5252
# Input: API headers + README as main page + local Doxygen pages +
5353
# the curated reports tree + the alias-vocabulary reference. Conceptual
5454
# guides with Material icons/images still live in MkDocs; Doxygen
5555
# carries the API reference and the design/inventory prose that
5656
# accompanies it.
5757
INPUT = ../h5cpp \
58-
../docs/index.md \
59-
../docs/reports \
60-
../docs/curated \
61-
../docs/aliases.md \
58+
docs/index.md \
59+
docs/reports \
60+
docs/curated \
61+
docs/aliases.md \
6262
../examples \
6363
.
6464

6565
FILE_PATTERNS = *.cpp *.hpp *.h *.md *.dox
6666
RECURSIVE = YES
6767

68-
EXCLUDE = ../docs/doxygen
68+
EXCLUDE = docs/doxygen
6969
# ../examples/ is added to INPUT only so README.md files become Doxygen
7070
# pages. Exclude the example *source* files from INPUT scanning — they're
7171
# already handled as `\example` listings via EXAMPLE_PATH below and shouldn't
@@ -130,7 +130,7 @@ EXAMPLE_PATH = ../examples/attributes \
130130
EXAMPLE_PATTERNS = *.cpp *.hpp *.h
131131
EXAMPLE_RECURSIVE = YES
132132

133-
USE_MDFILE_AS_MAINPAGE = ../docs/index.md
133+
USE_MDFILE_AS_MAINPAGE = docs/index.md
134134

135135
# Index and layout
136136
ALPHABETICAL_INDEX = NO
@@ -159,10 +159,10 @@ ENUM_VALUES_PER_LINE = 4
159159
GENERATE_LATEX = NO
160160

161161
# Tag files for cross-links
162-
TAGFILES += "../docs/tags/cppreference-doxygen-web.tag.xml=https://en.cppreference.com/"
162+
TAGFILES += "docs/tags/cppreference-doxygen-web.tag.xml=https://en.cppreference.com/"
163163

164164
# Alias includes — each file adds ALIASES lines
165-
@INCLUDE_PATH = ../docs/links
165+
@INCLUDE_PATH = docs/links
166166
@INCLUDE = h5cpp.txt
167167
@INCLUDE = hdf5.txt
168168
@INCLUDE = linalg.txt

0 commit comments

Comments
 (0)