summaryrefslogtreecommitdiffstats
path: root/tools/gendoc/doc/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'tools/gendoc/doc/index.rst')
-rw-r--r--tools/gendoc/doc/index.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/tools/gendoc/doc/index.rst b/tools/gendoc/doc/index.rst
new file mode 100644
index 0000000..b2a39fa
--- /dev/null
+++ b/tools/gendoc/doc/index.rst
@@ -0,0 +1,45 @@
+OpenLMI provider documentation
+==============================
+
+This documentation describes remote CIM interface of OpenLMI providers.
+Here we assume that the reader has some CIM knowledge and is able to:
+
+* Enumerate instances of a CIM class.
+* Call a method on a CIM instance.
+* Traverse CIM associations between instances.
+
+Please refer to XXX for documentation of OpenLMI client-side tools
+and libraries.
+
+Table of Content
+----------------
+
+.. toctree::
+ :maxdepth: 2
+
+ install
+ clones/openlmi-providers/src/account/doc/source/index
+ clones/openlmi-providers/src/logicalfile/doc/source/index
+ clones/openlmi-networking/build/doc/admin/index
+ clones/openlmi-storage/doc/admin/index
+
+OpenLMI Classes:
+
+.. toctree::
+ :maxdepth: 1
+
+ mof/tree
+ mof/index
+
+Version
+-------
+
+This documentation was automatically generated from:
+
+* openlmi-providers PROVIDERSVER
+* openlmi-networking NETWORKINGVER
+* openlmi-storage STORAGEVER
+
+.. |time| date::
+
+Generated on |time|.