1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
#!/bin/bash
# Copyright (c) 2008-2025 the MRtrix3 contributors.
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# Covered Software is provided under this License on an "as is"
# basis, without warranty of any kind, either expressed, implied, or
# statutory, including, without limitation, warranties that the
# Covered Software is free of defects, merchantable, fit for a
# particular purpose or non-infringing.
# See the Mozilla Public License v. 2.0 for more details.
#
# For more details, see http://www.mrtrix.org/.
#
# Generate .rst documentation for commands/scripts listing
# Based off of the update_doc script originally used to update the MRtrix wiki
#
# Author: Rami Tabbara
#
function prepend {
echo -e "$1" | cat - "$2" > "$2".tmp && mv "$2".tmp "$2"
}
# Generating documentation for all commands
mrtrix_root=$( cd "$(dirname "${BASH_SOURCE}")"/../ ; pwd -P )
export PATH=$mrtrix_root/bin:"$PATH"
dirpath=${mrtrix_root}'/docs/reference/commands'
export LC_ALL=C
# Erase legacy files
rm -rf ${mrtrix_root}/docs/reference/scripts ${mrtrix_root}/docs/reference/scripts_list.rst
echo "
.. _list-of-mrtrix3-commands:
########################
List of MRtrix3 commands
########################
" > ${mrtrix_root}/docs/reference/commands_list.rst
rm -rf ${mrtrix_root}/docs/reference/commands
mkdir -p ${mrtrix_root}/docs/reference/commands
toctree_file=$(mktemp)
table_file=$(mktemp)
echo "
.. toctree::
:hidden:
" > $toctree_file
echo "
.. csv-table::
:header: \"Lang\", \"Command\", \"Synopsis\"
" > $table_file
cmdlist=""
for n in `find "${mrtrix_root}"/cmd/ -name "*.cpp"`; do
cmdlist=$cmdlist$'\n'`basename $n`
done
for n in `find "${mrtrix_root}"/bin/ -type f -print0 | xargs -0 grep -l "import mrtrix3"`; do
cmdlist=$cmdlist$'\n'`basename $n`
done
for n in `echo "$cmdlist" | sort`; do
cmdname=${n%".cpp"}
cmdpath=$cmdname
logopath="python.png"
case $n in *.cpp)
if [ "$OSTYPE" == "cygwin" ] || [ "$OSTYPE" == "msys" ] || [ "$OSTYPE" == "win32" ]; then
cmdpath=${cmdpath}'.exe'
fi
logopath="cpp.png"
;;
esac
$cmdpath __print_usage_rst__ > $dirpath/$cmdname.rst
case $n in *.cpp)
prepend ".. _${cmdname}:\n\n${cmdname}\n===================\n" $dirpath/$cmdname.rst
esac
echo ' commands/'"$cmdname" >> $toctree_file
echo ' |'"$logopath"'|, :ref:`'"$cmdname"'`, "'`$cmdpath __print_synopsis__`'"' >> $table_file
done
cat $toctree_file $table_file >> ${mrtrix_root}/docs/reference/commands_list.rst
rm -f $toctree_file $table_file
echo "
.. |cpp.png| image:: cpp.png
:alt: C++
.. |python.png| image:: python.png
:alt: Python
" >> ${mrtrix_root}/docs/reference/commands_list.rst
# Generating list of configuration file options
grep -rn --include=\*.h --include=\*.cpp '^\s*//CONF\b' "${mrtrix_root}" |\
"${mrtrix_root}"/docs/format_config_options > ${mrtrix_root}/docs/reference/config_file_options.rst
# Generating list of environment variables
grep -rn --include=\*.h --include=\*.cpp '^\s*//ENVVAR\b' "${mrtrix_root}" |\
"${mrtrix_root}"/docs/format_environment_variables > ${mrtrix_root}/docs/reference/environment_variables.rst
|
