summaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorJan Safranek <jsafrane@redhat.com>2013-10-02 10:42:35 +0200
committerJan Safranek <jsafrane@redhat.com>2013-10-02 10:42:35 +0200
commitf056906076b2bee0f95d5b57eb57d76d77787446 (patch)
treeb75bbfae912bff8132e7c646fa82c42768efa611 /tools
parentc1f06a0b8745c2859c6f09789fd5965d87579c63 (diff)
downloadopenlmi-providers-f056906076b2bee0f95d5b57eb57d76d77787446.tar.gz
openlmi-providers-f056906076b2bee0f95d5b57eb57d76d77787446.tar.xz
openlmi-providers-f056906076b2bee0f95d5b57eb57d76d77787446.zip
Add 'gendoc' tool to generate overall documentation of all OpenLMI subprojects.
Diffstat (limited to 'tools')
-rw-r--r--tools/gendoc/README63
-rw-r--r--tools/gendoc/doc/Makefile156
-rw-r--r--tools/gendoc/doc/conf.py290
-rw-r--r--tools/gendoc/doc/index.rst45
-rw-r--r--tools/gendoc/doc/install.rst5
-rw-r--r--tools/gendoc/doc/mof/Makefile29
-rw-r--r--tools/gendoc/doc/mof/header.txt2
-rwxr-xr-xtools/gendoc/gendoc17
-rwxr-xr-xtools/gendoc/gendoc-mock-inside55
-rw-r--r--tools/openlmitheme/static/openlmi.css14
10 files changed, 675 insertions, 1 deletions
diff --git a/tools/gendoc/README b/tools/gendoc/README
new file mode 100644
index 0000000..fc5e272
--- /dev/null
+++ b/tools/gendoc/README
@@ -0,0 +1,63 @@
+Documentation generator for OpenLMI
+===================================
+
+OpenLMI uses Sphinx [1] for documentation of our providers. Documentation is
+kept close with appropriate provider implementations, that means it is spread
+across all OpenLMI git repositories. Since each OpenLMI provider has slightly
+different way how to generate documentation for it, this tool helps to compose
+the documentation together into one HTML site with all providers and OpenLMI
+classes.
+
+[1]: http://sphinx-doc.org/
+
+
+Design
+------
+
+The 'gendoc' tool is highly tailored to Fedora, as it uses 'mock' tool to create
+reproducible and untainted chroot with all tools needed to generate the docs.
+Documentation is always generated from fresh git clone.
+
+./gendoc tool does:
+
+- Install all necessary tools to appropriate mock chroot (planuml, dia, ...)
+- Inside the mock:
+ - Download git repositories of all OpenLMI provider subprojects.
+ - Check out given tag of OpenLMI provider subprojects.
+ - Therefore it's possible to generate docs for e.g. openlmi-storage 0.6.0,
+ openlmi-providers 0.3.0 and openlmi-networking 0.2.0.
+ - "Pre-build" the documentation, i.e. generate all SVG images and other files
+ individually for each provider.
+ - Generate RST files for all classes in MOF files for all providers.
+ - Finally, generate HTML documentation.
+
+Usage
+-----
+
+./gendoc -r <mock configuration name> <openlmi-providers tag> <openlmi-networking tag> <openlmi-storage tag>'
+
+Where:
+
+<mock configuration name> = name of MOCK configuration file, without .cfg
+ suffix. Typically 'fedora-devel-x86_64'.
+
+<openlmi-providers tag> = name of tag in openlmi-providers git repository for
+ which is the documentation generated.
+ ./gendoc tool checks out this tag before the
+ documentation is generated.
+ 'master' can be used for current git master head.
+
+<openlmi-networking tag>, <openlmi-storage tag> = dtto.
+
+
+Example:
+
+# initialize the mock (only the 1st. time)
+mock -r fedora-devel-x86_64 init
+
+# Generate doc for specific tags:
+./gendoc -r fedora-devel-x86_64 0.3.0 0.6.0 0.2.0
+
+# Generate doc for current git masters:
+./gendoc -r fedora-devel-x86_64 master master master
+
diff --git a/tools/gendoc/doc/Makefile b/tools/gendoc/doc/Makefile
new file mode 100644
index 0000000..eb785f6
--- /dev/null
+++ b/tools/gendoc/doc/Makefile
@@ -0,0 +1,156 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+mofs:
+ make -C mof
+
+html: mofs
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenLMI.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenLMI.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenLMI"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenLMI"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/tools/gendoc/doc/conf.py b/tools/gendoc/doc/conf.py
new file mode 100644
index 0000000..ee12eff
--- /dev/null
+++ b/tools/gendoc/doc/conf.py
@@ -0,0 +1,290 @@
+# -*- coding: utf-8 -*-
+#
+# OpenLMI documentation build configuration file, created by
+# sphinx-quickstart on Thu Sep 12 11:07:33 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+def setup(app):
+ app.add_config_value('includeClasses', 'True', True)
+
+includeClasses = False
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.ifconfig']
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'OpenLMI'
+copyright = u'OpenLMI authors'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = 'PROVIDERSVER'
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'openlmitheme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = False
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = False
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OpenLMIStorageProviderdoc'
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'OpenLMI.tex', u'OpenLMI Documentation',
+ u'OpenLMI authors', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'openlmi', u'OpenLMI Documentation',
+ [u'OpenLMI authors'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'OpenLMI', u'OpenLMI Documentation',
+ u'OpenLMI authors', 'OpenLMI', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'OpenLMI'
+epub_author = u'OpenLMI authors'
+epub_publisher = u'OpenLMI authors'
+epub_copyright = u'2013, OpenLMI authors'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
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|.
diff --git a/tools/gendoc/doc/install.rst b/tools/gendoc/doc/install.rst
new file mode 100644
index 0000000..0ed8dc7
--- /dev/null
+++ b/tools/gendoc/doc/install.rst
@@ -0,0 +1,5 @@
+OpenLMI provider installation
+=============================
+
+Please refer to README of individual providers, either in git
+or in released tarballs.
diff --git a/tools/gendoc/doc/mof/Makefile b/tools/gendoc/doc/mof/Makefile
new file mode 100644
index 0000000..9882f7d
--- /dev/null
+++ b/tools/gendoc/doc/mof/Makefile
@@ -0,0 +1,29 @@
+all: index.rst
+
+MOFS=../clones/openlmi-providers/mof/05_LMI_Qualifiers.mof \
+ ../clones/openlmi-providers/mof/30_LMI_Jobs.mof \
+ ../clones/openlmi-providers/mof/60_LMI_Account.mof \
+ ../clones/openlmi-providers/mof/60_LMI_Fan.mof \
+ ../clones/openlmi-providers/mof/60_LMI_Hardware.mof \
+ ../clones/openlmi-providers/mof/60_LMI_LogicalFile.mof \
+ ../clones/openlmi-providers/mof/60_LMI_PCP.mof \
+ ../clones/openlmi-providers/mof/60_LMI_PowerManagement.mof \
+ ../clones/openlmi-providers/mof/60_LMI_Realmd.mof \
+ ../clones/openlmi-providers/mof/60_LMI_Service.mof \
+ ../clones/openlmi-providers/mof/60_LMI_Software.mof \
+ ../clones/openlmi-networking/mof/60_LMI_Networking.mof \
+ ../clones/openlmi-storage/mof/LMI_Storage-Base.mof \
+ ../clones/openlmi-storage/mof/LMI_Storage-BlockStorage.mof \
+ ../clones/openlmi-storage/mof/LMI_Storage-Filesystem.mof \
+ ../clones/openlmi-storage/mof/LMI_Storage-Jobs.mof \
+ ../clones/openlmi-storage/mof/LMI_Storage-Luks.mof \
+ ../clones/openlmi-storage/mof/LMI_Storage-Mounting.mof \
+ ../clones/openlmi-storage/mof/LMI_Storage-Partitions.mof
+
+clean:
+ rm -f *.rst
+
+index.rst: $(MOFS)
+ openlmi-doc-class2rst -H header.txt -M `echo $(MOFS) | sed 's/ / -M /g'` \
+ -S /usr/share/mof/cim-current/CIM_Schema.mof \
+ `cat $(MOFS) | grep "^class" | cut -d ' ' -f 2 | sed 's/://'`
diff --git a/tools/gendoc/doc/mof/header.txt b/tools/gendoc/doc/mof/header.txt
new file mode 100644
index 0000000..cc06402
--- /dev/null
+++ b/tools/gendoc/doc/mof/header.txt
@@ -0,0 +1,2 @@
+Class reference
+===============
diff --git a/tools/gendoc/gendoc b/tools/gendoc/gendoc
new file mode 100755
index 0000000..68dfa7b
--- /dev/null
+++ b/tools/gendoc/gendoc
@@ -0,0 +1,17 @@
+#!/bin/bash -x
+
+if [ $# -ne 4 ]; then
+ echo "Usage: $0 <mock-config> <openlmi-providers tag> <openlmi-networking tag> <openlmi-storage tag>"
+ exit 1
+fi
+
+MOCK=$1
+shift
+
+mock -r $MOCK --install plantuml konkretcmpi-devel openlmi-providers-devel git dia python-sphinx cim-schema cmake sblim-cmpi-devel glib2-devel check-devel NetworkManager-devel libuuid-devel dbus-glib-devel python-sphinx-theme-openlmi graphviz
+mock -r $MOCK --shell "rm -rf /builddir/doc/ /builddir/gendoc-mock-inside"
+mock -r $MOCK --copyin gendoc-mock-inside /builddir || exit 1
+mock -r $MOCK --copyin doc /builddir/doc || exit 1
+mock -r $MOCK --shell /builddir/gendoc-mock-inside $* || exit 1
+mock -r $MOCK --copyout /builddir/doc/doc.tgz . || exit 1
+mock -r $MOCK --shell "rm -rf /builddir/doc/* /builddir/gendoc-mock-inside"
diff --git a/tools/gendoc/gendoc-mock-inside b/tools/gendoc/gendoc-mock-inside
new file mode 100755
index 0000000..6550cc8
--- /dev/null
+++ b/tools/gendoc/gendoc-mock-inside
@@ -0,0 +1,55 @@
+#!/bin/bash -x
+
+cd $HOME/doc || exit 1
+
+# clone all git reprositories
+mkdir clones || exit 1
+pushd clones || exit 1
+git clone https://git.fedorahosted.org/git/openlmi-providers.git || exit 1
+pushd openlmi-providers || exit 1
+git checkout $1 || exit 1
+popd
+
+git clone https://git.fedorahosted.org/git/openlmi-networking.git || exit 1
+pushd openlmi-networking || exit 1
+git checkout $2 || exit 1
+popd
+
+git clone https://git.fedorahosted.org/git/openlmi-storage.git || exit 1
+pushd openlmi-storage || exit 1
+git checkout $3 || exit 1
+popd
+
+popd
+
+# prepare pictures
+pushd clones/openlmi-storage/doc/admin
+make src || exit 1
+# 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/
+make html || exit 1
+# we don't want class documentation here, there will be one
+# on the top level
+rm -rf source/mof/*.rst
+popd
+
+pushd clones/openlmi-networking
+mkdir build || exit 1
+cd build || exit 1
+cmake .. || exit 1
+make doc || exit 1
+# we don't want class documentation here, there will be one
+# on the top level
+rm -rf doc/admin/mof/*.rst
+popd
+
+# Update project versions in RST files
+sed -i -e "s/PROVIDERSVER/$1/" -e "s/NETWORKINGVER/$2/" -e "s/STORAGEVER/$3/" *.rst *.py
+
+make html || exit 1
+
+tar cfz doc.tgz _build/html || exit 1
diff --git a/tools/openlmitheme/static/openlmi.css b/tools/openlmitheme/static/openlmi.css
index a61c777..ace2d3e 100644
--- a/tools/openlmitheme/static/openlmi.css
+++ b/tools/openlmitheme/static/openlmi.css
@@ -1,5 +1,7 @@
@import url("default.css");
+/* Most of this file is taken from openlmi.org CSS */
+
p.caption {
font-size: 90%;
font-style: italic;
@@ -61,6 +63,16 @@ div.sphinxsidebarwrapper {
word-wrap: break-word; /* don't overflow with large items like LMI_SoftwareInstallationServiceAffectsElement*/
}
+div.sphinxsidebar {
+ width: 280px; /* make the sidebar a bit wider */
+}
+div.bodywrapper {
+ margin: 0 0 0 280px; /* make the sidebar a bit wider */
+}
+div.sphinxsidebar #searchbox input[type="submit"] {
+ word-wrap: normal; /* don't wrap the search button */
+}
+
div.sphinxsidebar ul {
margin: 10px 0px 10px 0px;
-} \ No newline at end of file
+}