From c15f9ee5a0e25a91781e4c23f1cfb0ca7c5b7336 Mon Sep 17 00:00:00 2001 From: Jan Safranek Date: Fri, 18 Oct 2013 14:45:03 +0200 Subject: 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. --- README | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'README') 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 -- cgit