summaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
Diffstat (limited to 'tools')
-rwxr-xr-xtools/docs-api9
-rwxr-xr-xtools/docs-setup10
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