diff options
| author | Michal Minar <miminar@redhat.com> | 2013-09-11 13:13:13 +0200 |
|---|---|---|
| committer | Michal Minar <miminar@redhat.com> | 2013-09-11 13:18:23 +0200 |
| commit | 795187aaf623f87442474f0f0f28825515e71083 (patch) | |
| tree | 5ea100ee72975441502af20baa4a173ebda806f3 /doc | |
| parent | c04bc5fa22c86113f7752a763ecd7b0d60d2beb7 (diff) | |
| download | openlmi-scripts-795187aaf623f87442474f0f0f28825515e71083.tar.gz openlmi-scripts-795187aaf623f87442474f0f0f28825515e71083.tar.xz openlmi-scripts-795187aaf623f87442474f0f0f28825515e71083.zip | |
added a note about version of sources
Diffstat (limited to 'doc')
| -rwxr-xr-x | doc/gendoc.sh | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/gendoc.sh b/doc/gendoc.sh index 8803413..4ce3244 100755 --- a/doc/gendoc.sh +++ b/doc/gendoc.sh @@ -2,7 +2,7 @@ # # Helper script to generate developer documentation in -# doc/devel/modules and index.rst +# doc/modules and api.rst # TOPDIR=.. @@ -22,6 +22,15 @@ function get_module_name() { basename -s .py "$path" } +function get_version_string() { + out=`python $TOPDIR/setup.py --version` + git_version=`git describe HEAD 2>/dev/null` + echo -n "\`\`$out\`\`" + if [ -n "$git_version" ]; then + echo ", git: \`\`$git_version\`\`" + fi +} + # api.rst header cat >$TOPDIR/doc/api.rst <<_EOF_ OpenLMI Scripts API @@ -33,6 +42,8 @@ Developer of script library will be interested in :py:mod:\`lmi.scripts.common\` package providing useful functionality to script development. +Generated from version: $(get_version_string) + Contents: .. toctree:: |