diff options
author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2022-07-17 14:18:24 +0200 |
---|---|---|
committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2022-07-17 14:18:24 +0200 |
commit | eaeb5f7567d51d2e89875e9b51012a05fa3397de (patch) | |
tree | 87a0fa7fe39bfca19d7b782b5c4032abbaf804f3 /docs/update_reference.sh | |
parent | 1b8cf086ff0480fb2c296c72ada3baa80ea24648 (diff) |
Script to update the reference documentation files
Diffstat (limited to 'docs/update_reference.sh')
-rwxr-xr-x | docs/update_reference.sh | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/update_reference.sh b/docs/update_reference.sh new file mode 100755 index 0000000..784ea2b --- /dev/null +++ b/docs/update_reference.sh @@ -0,0 +1,13 @@ +#!/bin/sh + +# This script generates new autodoc files for the hazwaz reference, overwriting +# all existing files. + +cd $(dirname "$0")/.. + +echo "This will overwrite all existing files in the docs/source/reference/" +echo "continue? (press enter to continue, or ctrl-C to abort)" + +read continue + +sphinx-apidoc -f -e -M -o docs/source/reference/ hazwaz $* |