swh:1:snp:02443124ed4ee0d8d724fefd38bf9b271361cc09
Tip revision: 25441834a5e8891a4e3a2ea98db283fcb29047b5 authored by Jan-Michael Rye on 28 July 2023, 15:05:06 UTC
Add release job to GitLab CI
Add release job to GitLab CI
Tip revision: 2544183
generate_doc_mds.sh
#!/usr/bin/env bash
set -euo pipefail
SELF=$(readlink -f "${BASH_SOURCE[0]}")
cd -- "${SELF%%/*/*}"
# ------------------- Create, activate and configure venv -------------------- #
if [[ ! -d ./venv ]]
then
python3 -m venv venv
fi
source ./venv/bin/activate
pip install -U pip
pip install -U .
# -------------------------------- Functions --------------------------------- #
function append_cmd_help()
{
local path=$1
local subcmd=${2:-}
local cmd
if [[ -n $subcmd ]]
then
cmd=(chemfeat "$subcmd" --help)
cat >> "$path" << MD
## ${subcmd^}
MD
else
cmd=(chemfeat --help)
fi
cat >> "$path" << MD
~~~
\$ ${cmd[*]}
$("${cmd[@]}" 2>&1)
~~~
MD
}
function gen_cmd_help()
{
local path=$1
cat > "$path" << MD
# Command-Line Usage
The package provides the \`chemfeat\` executable which recognizes several subcommands:
MD
append_cmd_help "$path"
for subcmd in calculate configure describe
do
append_cmd_help "$path" "$subcmd"
done
}
function gen_conf()
{
path=$1
cat > "$path" << 'CONF'
# Feature-set Configuration File
~~~yaml
CONF
chemfeat conf >> "$path"
echo '~~~' >> "$path"
}
# --------------------------------- Generate --------------------------------- #
gen_cmd_help ./doc/source/gen_command_help.md
chemfeat desc -o ./doc/source/gen_features.md
gen_conf ./doc/source/gen_feature_set_configuration.md