diff options
| author | Jan Safranek <jsafrane@redhat.com> | 2013-10-17 09:29:44 +0200 |
|---|---|---|
| committer | Jan Safranek <jsafrane@redhat.com> | 2013-10-17 09:29:44 +0200 |
| commit | fcc36e8a12e0cb87c8ca8297403cfc3dc29e68f6 (patch) | |
| tree | a16e4c129ead9ecdf30c8ad6b1b3cde8104234fb /tools | |
| parent | d600c0bb93c7ef7ee2751f540fa2f5fa3749cd2f (diff) | |
| download | openlmi-providers-fcc36e8a12e0cb87c8ca8297403cfc3dc29e68f6.tar.gz openlmi-providers-fcc36e8a12e0cb87c8ca8297403cfc3dc29e68f6.tar.xz openlmi-providers-fcc36e8a12e0cb87c8ca8297403cfc3dc29e68f6.zip | |
Add hardware, software and service documentation to the generator.
Also the gendoc tool now creates standalone documentation for each provider
alongside the overall documentation.
Diffstat (limited to 'tools')
| -rw-r--r-- | tools/gendoc/doc/index.rst | 4 | ||||
| -rwxr-xr-x | tools/gendoc/gendoc-mock-inside | 39 |
2 files changed, 38 insertions, 5 deletions
diff --git a/tools/gendoc/doc/index.rst b/tools/gendoc/doc/index.rst index 88db9a4..c1f3892 100644 --- a/tools/gendoc/doc/index.rst +++ b/tools/gendoc/doc/index.rst @@ -20,7 +20,11 @@ Table of Content install config clones/openlmi-providers/src/account/doc/source/index + clones/openlmi-providers/src/hardware/doc/source/index clones/openlmi-providers/src/logicalfile/doc/source/index + clones/openlmi-providers/src/realdm/doc/source/index + clones/openlmi-providers/src/service-dbus/doc/source/index + clones/openlmi-providers/src/software/doc/admin/index clones/openlmi-networking/build/doc/admin/index clones/openlmi-storage/doc/admin/index diff --git a/tools/gendoc/gendoc-mock-inside b/tools/gendoc/gendoc-mock-inside index 6550cc8..b2e7ce2 100755 --- a/tools/gendoc/gendoc-mock-inside +++ b/tools/gendoc/gendoc-mock-inside @@ -22,26 +22,52 @@ popd popd -# prepare pictures +# prepare output directory +OUT=~/out +mkdir $OUT + +# build docs for individual providers pushd clones/openlmi-storage/doc/admin -make src || exit 1 +make fullhtml || exit 1 +mkdir -p $OUT/openlmi-storage/$3 +cp -r _build/html/* $OUT/openlmi-storage/$3/ +# prepare the directory for inclusion in overall documentation # we don't want class documentation here, there will be one # on the top level rm -rf mof/*.rst popd -pushd clones/openlmi-providers/src/account/doc/ +for d in account hardware logicalfile realmd service-dbus; do + pushd clones/openlmi-providers/src/$d/doc/ + make html || exit 1 + mkdir -p $OUT/openlmi-providers/$1/$d + cp -r build/html/* $OUT/openlmi-providers/$1/$d/ + # prepare the directory for inclusion in overall documentation + # we don't want class documentation here, there will be one + # on the top level + rm -rf source/mof/*.rst + popd +done + +pushd clones/openlmi-providers/src/software/doc/admin make html || exit 1 +mkdir -p $OUT/openlmi-providers/$1/software +cp -r _build/html/* $OUT/openlmi-providers/$1/software +# prepare the directory for inclusion in overall documentation # we don't want class documentation here, there will be one # on the top level -rm -rf source/mof/*.rst +rm -rf mof/*.rst popd + pushd clones/openlmi-networking mkdir build || exit 1 cd build || exit 1 cmake .. || exit 1 make doc || exit 1 +mkdir -p $OUT/openlmi-networking/$2 +cp -r doc/admin/html/* $OUT/openlmi-networking/$2/ +# prepare the directory for inclusion in overall documentation # we don't want class documentation here, there will be one # on the top level rm -rf doc/admin/mof/*.rst @@ -50,6 +76,9 @@ popd # Update project versions in RST files sed -i -e "s/PROVIDERSVER/$1/" -e "s/NETWORKINGVER/$2/" -e "s/STORAGEVER/$3/" *.rst *.py +# Generate the overall documentation make html || exit 1 +mkdir $OUT/all +cp -r _build/html/* $OUT/all -tar cfz doc.tgz _build/html || exit 1 +tar cfz doc.tgz $OUT || exit 1 |