Skip to content

Commit 2b14747

Browse files
committed
Explicitly dump the specifications into gh-pages as markdown.
This avoids unnecessary conversion via doxygen and simplifies the links.
1 parent 8b973b1 commit 2b14747

File tree

3 files changed

+19
-15
lines changed

3 files changed

+19
-15
lines changed

.github/workflows/doxygenate.yaml

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,22 @@ jobs:
4040
with:
4141
args: -O docs/doxygen-awesome.css https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css
4242

43-
- name: Download markdown
44-
uses: actions/download-artifact@v3
45-
with:
46-
name: built-spec
47-
path: docs/specifications/compiled
48-
4943
- name: Doxygen Action
5044
uses: mattnotmitt/doxygen-action@v1
5145
with:
5246
working-directory: docs/
5347

48+
- name: Doxygen Action
49+
run: |
50+
ls -lR
51+
chmod -R 777 docs/html
52+
53+
- name: Download markdown
54+
uses: actions/download-artifact@v3
55+
with:
56+
name: built-spec
57+
path: docs/html/specifications
58+
5459
- name: GH Pages Deployment
5560
uses: JamesIves/github-pages-deploy-action@v4
5661
with:

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ In contrast, JSON is easier to parse and has less storage overhead per list elem
2121
Both the HDF5 and JSON specifications have multiple versions.
2222
Links to the version-specific HDF5 specifications are listed below, along with the minimum version of the C++ library required to parse them:
2323

24-
- [1.3](https://artifactdb.github.io/uzuki2/md__github_workspace_docs_specifications_compiled_hdf5_1_3.html), supported by **uzuki2** version ≥ 1.3.
25-
- [1.2](https://artifactdb.github.io/uzuki2/md__github_workspace_docs_specifications_compiled_hdf5_1_2.html), supported by **uzuki2** version ≥ 1.2.
26-
- [1.1](https://artifactdb.github.io/uzuki2/md__github_workspace_docs_specifications_compiled_hdf5_1_1.html), supported by **uzuki2** version ≥ 1.1.
27-
- [1.0](https://artifactdb.github.io/uzuki2/md__github_workspace_docs_specifications_compiled_hdf5_1_0.html), supported by **uzuki2** version ≥ 1.0.
24+
- [1.3](https://github.com/ArtifactDB/uzuki2/tree/gh-pages/docs/specifications/hdf5-1.3.md), supported by **uzuki2** version ≥ 1.3.
25+
- [1.2](https://github.com/ArtifactDB/uzuki2/tree/gh-pages/docs/specifications/hdf5-1.2.md), supported by **uzuki2** version ≥ 1.2.
26+
- [1.1](https://github.com/ArtifactDB/uzuki2/tree/gh-pages/docs/specifications/hdf5-1.1.md), supported by **uzuki2** version ≥ 1.1.
27+
- [1.0](https://github.com/ArtifactDB/uzuki2/tree/gh-pages/docs/specifications/hdf5-1.0.md), supported by **uzuki2** version ≥ 1.0.
2828

2929
Similarly, different versions of the JSON specification are listed below:
3030

31-
- [1.2](https://artifactdb.github.io/uzuki2/md__github_workspace_docs_specifications_compiled_json_1_2.html), supported by **uzuki2** version ≥ 1.2.
32-
- [1.1](https://artifactdb.github.io/uzuki2/md__github_workspace_docs_specifications_compiled_json_1_1.html), supported by **uzuki2** version ≥ 1.1.
33-
- [1.0](https://artifactdb.github.io/uzuki2/md__github_workspace_docs_specifications_compiled_json_1_0.html), supported by **uzuki2** version ≥ 1.0.
31+
- [1.2](https://github.com/ArtifactDB/uzuki2/tree/gh-pages/docs/specifications/json-1.2.md), supported by **uzuki2** version ≥ 1.2.
32+
- [1.1](https://github.com/ArtifactDB/uzuki2/tree/gh-pages/docs/specifications/json-1.1.md), supported by **uzuki2** version ≥ 1.1.
33+
- [1.0](https://github.com/ArtifactDB/uzuki2/tree/gh-pages/docs/specifications/json-1.0.md), supported by **uzuki2** version ≥ 1.0.
3434

3535
## Validation
3636

docs/Doxyfile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -794,8 +794,7 @@ INPUT = ../include/uzuki2/parse_json.hpp \
794794
../include/uzuki2/parse_hdf5.hpp \
795795
../include/uzuki2/interfaces.hpp \
796796
../include/uzuki2/uzuki2.hpp \
797-
../README.md \
798-
specifications/compiled
797+
../README.md
799798

800799
# This tag can be used to specify the character encoding of the source files
801800
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

0 commit comments

Comments
 (0)