Skip to content

Commit

Permalink
Explicitly dump the specifications into gh-pages as markdown.
Browse files Browse the repository at this point in the history
This avoids unnecessary conversion via doxygen and simplifies the links.
  • Loading branch information
LTLA committed Jan 4, 2024
1 parent 8b973b1 commit 0e9d228
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 15 deletions.
12 changes: 6 additions & 6 deletions .github/workflows/doxygenate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,17 @@ jobs:
with:
args: -O docs/doxygen-awesome.css https://raw.githubusercontent.com/jothepro/doxygen-awesome-css/main/doxygen-awesome.css

- name: Download markdown
uses: actions/download-artifact@v3
with:
name: built-spec
path: docs/specifications/compiled

- name: Doxygen Action
uses: mattnotmitt/doxygen-action@v1
with:
working-directory: docs/

- name: Download markdown
uses: actions/download-artifact@v3
with:
name: built-spec
path: docs/html/specifications

- name: GH Pages Deployment
uses: JamesIves/github-pages-deploy-action@v4
with:
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ In contrast, JSON is easier to parse and has less storage overhead per list elem
Both the HDF5 and JSON specifications have multiple versions.
Links to the version-specific HDF5 specifications are listed below, along with the minimum version of the C++ library required to parse them:

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

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

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

## Validation

Expand Down
3 changes: 1 addition & 2 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -794,8 +794,7 @@ INPUT = ../include/uzuki2/parse_json.hpp \
../include/uzuki2/parse_hdf5.hpp \
../include/uzuki2/interfaces.hpp \
../include/uzuki2/uzuki2.hpp \
../README.md \
specifications/compiled
../README.md

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

0 comments on commit 0e9d228

Please sign in to comment.