diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2024-10-16 01:30:44 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2024-10-16 01:39:26 -0400 |
| commit | 56e16e29db55dae84549229d24b971f8bcf7da21 (patch) | |
| tree | 675c22c953eca3257ad5011ba35a8add35d34d9f /tools | |
| parent | 54a62a3ff06fc132b3ea8506efbce06c5e0869fe (diff) | |
API docs rewrite.
Having the whole API in a single file was starting to feel very cramped and constraining. This rewrite breaks it out into sections; as a side effect, the docs are now about 2.5x as long as they were, as the rewrite allows more space for each idea without crowding the page.
The docs are best read by running `tools/docs-api`.
Diffstat (limited to 'tools')
| -rwxr-xr-x | tools/docs-api | 9 | ||||
| -rwxr-xr-x | tools/docs-setup | 10 |
2 files changed, 19 insertions, 0 deletions
diff --git a/tools/docs-api b/tools/docs-api new file mode 100755 index 0000000..fbc90b3 --- /dev/null +++ b/tools/docs-api @@ -0,0 +1,9 @@ +#!/bin/bash -e + +## tools/docs-api +## +## Builds (and opens) the API documentation. + +cd "$(dirname "$0")/.." + +mdbook serve --open docs/api diff --git a/tools/docs-setup b/tools/docs-setup new file mode 100755 index 0000000..77bcb62 --- /dev/null +++ b/tools/docs-setup @@ -0,0 +1,10 @@ +#!/bin/bash -e + +## tools/docs-setup +## +## Installs prerequisites for building the documentation. + +cd "$(dirname "$0")/.." + +cargo install mdbook +cargo install mdbook-mermaid |
