summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorJan Safranek <jsafrane@redhat.com>2013-10-18 14:45:03 +0200
committerJan Safranek <jsafrane@redhat.com>2013-10-18 14:45:03 +0200
commitc15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336 (patch)
treedc34216411938495b489368e15e22a7e5a5d0878 /README
parent087d51a3b03815ddbacaf62bf2fa047dbcbb9537 (diff)
downloadopenlmi-providers-c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336.tar.gz
openlmi-providers-c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336.tar.xz
openlmi-providers-c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336.zip
Rework documentation.
- Everything is in openlmi-providers/doc/admin directory. - 'make doc' automatically builds documentation of all enabled providers. - Documentation shares one 'conf.py' for sphinx. - All documentation uses the same directory structure. There is only one CMakefile.txt to generate all the docs.
Diffstat (limited to 'README')
-rw-r--r--README5
1 files changed, 5 insertions, 0 deletions
diff --git a/README b/README
index a62b061..c247d46 100644
--- a/README
+++ b/README
@@ -78,6 +78,10 @@ For all providers:
- sblim-cmpi-devel
- cim-schema
+For documentation:
+ - python-sphinx
+ - (optionally) plantuml
+
Provider specific dependencies:
* Fan
- lm_sensors - installed and configured
@@ -107,6 +111,7 @@ Provider specific dependencies:
$ mkdir build && cd build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr
$ make
+$ make doc
# make install
# make register-Fan
# make register-PowerManagement