summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJuergen Ryannel <juergen.bocklage-ryannel@pelagicore.com>2016-12-09 10:22:45 +0100
committerJuergen Ryannel <juergen.bocklage-ryannel@pelagicore.com>2016-12-09 10:22:45 +0100
commita521a2f66bd0a26be3a45c33fe72968fafec8dfa (patch)
treeb9860beea1c575de5d74a1a69d810d9f0790b674 /docs
parent68373b55131bc4117d5b977d73d854003d1f0e59 (diff)
downloadqtivi-qface-a521a2f66bd0a26be3a45c33fe72968fafec8dfa.tar.gz
converted documentation to use sphinx
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile230
-rw-r--r--docs/api.md43
-rw-r--r--docs/api.rst104
-rw-r--r--docs/builtin.rst (renamed from docs/builtin.md)41
-rw-r--r--docs/conf.py442
-rw-r--r--docs/domain.rst (renamed from docs/domain.md)48
-rw-r--r--docs/extending.md45
-rw-r--r--docs/extending.rst47
-rw-r--r--docs/grammar.md106
-rw-r--r--docs/grammar.rst111
-rw-r--r--docs/index.rst (renamed from docs/welcome.md)26
-rw-r--r--docs/make.bat281
-rw-r--r--docs/usage.md117
-rw-r--r--docs/usage.rst102
14 files changed, 1384 insertions, 359 deletions
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..5525794
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,230 @@
+# 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
+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 " applehelp to make an Apple Help Book"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " epub3 to make an epub3"
+ @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 " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @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 " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+ @echo " coverage to run coverage check of the documentation (if enabled)"
+ @echo " dummy to check syntax errors of document sources"
+
+.PHONY: clean
+clean:
+ rm -rf $(BUILDDIR)/*
+
+.PHONY: html
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: pickle
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+.PHONY: json
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+.PHONY: htmlhelp
+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."
+
+.PHONY: qthelp
+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/QFace.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/QFace.qhc"
+
+.PHONY: applehelp
+applehelp:
+ $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+ @echo
+ @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+ @echo "N.B. You won't be able to view it unless you put it in" \
+ "~/Library/Documentation/Help or install it in your application" \
+ "bundle."
+
+.PHONY: devhelp
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/QFace"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/QFace"
+ @echo "# devhelp"
+
+.PHONY: epub
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: epub3
+epub3:
+ $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
+ @echo
+ @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
+
+.PHONY: latex
+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)."
+
+.PHONY: latexpdf
+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."
+
+.PHONY: latexpdfja
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: text
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+.PHONY: man
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+.PHONY: texinfo
+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)."
+
+.PHONY: info
+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."
+
+.PHONY: gettext
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+.PHONY: changes
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+.PHONY: linkcheck
+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."
+
+.PHONY: doctest
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+ $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+ @echo "Testing of coverage in the sources finished, look at the " \
+ "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+.PHONY: dummy
+dummy:
+ $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
+ @echo
+ @echo "Build finished. Dummy builder generates no files."
+
+
+.PHONY: serve
+serve:
+ sphinx-autobuild --open-browser --delay=5 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
diff --git a/docs/api.md b/docs/api.md
deleted file mode 100644
index cf406e2..0000000
--- a/docs/api.md
+++ /dev/null
@@ -1,43 +0,0 @@
-# API
-
-The API mostly consist of two helper classes and the domain model. For the domain model, see the domain documentation.
-
-## qface.generator.FileSystem
-
-* FileSystem.parse_document(path: str, system: System = None)
-
- Parses a document and returns the resulting domain system
-
-* FileSystem.parse_dir(path, identifier: str = None, clear_cache=True)
-
- Recursively parses a directory and returns the resulting system
-
-* FileSystem.find_files(path, glob='*.qdl')
-
- Find recursively all files in the given path using the glob parameter
-
-## qface.generator.Generator
-
-* Generator(searchpath)
-
- Manages the templates and applies your context data
-
-* generator.get_template(self, name: str)
-
- Retrievs a single template file from the template loader
-
-* generator.render(self, name: str, context: dict)
-
- Returns the rendered text from a single template file
-
-* generator.apply(self, template: Template, context: dict)
-
- Return the rendered text of a template instance
-
-* generator.write(self, fileTemplate: str, template: str, context: dict)
-
- Using a templated file name it renders a template into a file given a context
-
-* generator.register_filter(self, name, callback)
-
- Register your custom template filter
diff --git a/docs/api.rst b/docs/api.rst
new file mode 100644
index 0000000..76a3970
--- /dev/null
+++ b/docs/api.rst
@@ -0,0 +1,104 @@
+===
+API
+===
+
+
+Generator API
+=============
+
+.. inheritance-diagram:: qface.generator
+
+
+Generator Class
+---------------
+
+.. module:: qface.generator
+
+Provides an API for accessing the file system and controlling the generator
+
+
+FileSystem Class
+----------------
+
+.. autoclass:: qface.generator.FileSystem
+ :members:
+
+
+.. autoclass:: qface.generator.Generator
+ :members:
+
+
+Template Domain API
+===================
+
+.. module:: qface.idl.domain
+
+This API is exposed to the Jinja template system.
+
+.. inheritance-diagram:: qface.idl.domain
+
+High Level Classes
+------------------
+
+.. autoclass:: qface.idl.domain.System
+ :members:
+
+.. autoclass:: qface.idl.domain.Module
+ :members:
+ :show-inheritance:
+
+
+Interface Related Classes
+-------------------------
+
+.. autoclass:: qface.idl.domain.Interface
+ :members:
+
+
+.. autoclass:: qface.idl.domain.Operation
+ :members:
+
+.. autoclass:: qface.idl.domain.Parameter
+ :members:
+
+.. autoclass:: qface.idl.domain.Property
+ :members:
+
+
+Struct Related Classes
+----------------------
+
+.. autoclass:: qface.idl.domain.Struct
+ :members:
+ :show-inheritance:
+
+
+.. autoclass:: qface.idl.domain.Field
+ :members:
+ :show-inheritance:
+
+.. rubric:: Enum/Flag Related Classes
+
+.. autoclass:: qface.idl.domain.Enum
+ :members:
+ :show-inheritance:
+
+.. autoclass:: qface.idl.domain.EnumMember
+ :members:
+ :show-inheritance:
+
+
+Base Classes
+------------
+
+.. autoclass:: qface.idl.domain.Symbol
+ :members:
+ :show-inheritance:
+
+.. autoclass:: qface.idl.domain.TypedSymbol
+ :members:
+ :show-inheritance:
+
+.. autoclass:: qface.idl.domain.TypeSymbol
+ :members:
+ :show-inheritance:
diff --git a/docs/builtin.md b/docs/builtin.rst
index fd04109..7e7ec03 100644
--- a/docs/builtin.md
+++ b/docs/builtin.rst
@@ -1,6 +1,8 @@
-# Builtin Generators
+Builtin Generators
+==================
-## QtCPP Generator
+QtCPP Generator
+---------------
This is one of the buit-in generators to generate a QtCPP API to be exported into QML.
The structs/enums/flags are defined in an own Module Qbject which acts as a namespace and can not be instantiated.
@@ -9,29 +11,31 @@ Each interface is generated into a QObject with proper properties, signals and i
For example an QDL like this:
-```js
-module sample 1.0
+.. code-block:: js
-interface Heater {
- real temperature;
- Status status;
- void increaseTemperature(qreal step);
- void decreaseTemperature(qreal step);
- event void error(string message);
-}
+ module sample 1.0
+
+ interface Heater {
+ real temperature;
+ Status status;
+ void increaseTemperature(qreal step);
+ void decreaseTemperature(qreal step);
+ event void error(string message);
+ }
+
+ enum Status {
+ Null,
+ Ready,
+ Error
+ }
-enum Status {
- Null,
- Ready,
- Error
-}
-```
The QTCPP generator will generate all CPP code including the plugin code and project files. Additional it will generate an empy simulation stub.
In QML you would now be able to write the following code.
-```qml
+.. code-block:: qml
+
import sample 1.0
Item {
@@ -55,4 +59,3 @@ In QML you would now be able to write the following code.
}
}
}
-``` \ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..698400d
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,442 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# QFace documentation build configuration file, created by
+# sphinx-quickstart on Fri Dec 9 09:10:54 2016.
+#
+# 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.
+
+# 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.
+#
+import os
+import sys
+
+here = os.path.dirname(__file__)
+
+sys.path.insert(0, os.path.join(here, '..'))
+print('path: ', sys.path)
+
+# -- 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.autodoc',
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.todo',
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.viewcode',
+ 'sphinx.ext.githubpages',
+ 'sphinx.ext.inheritance_diagram',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+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 = 'QFace'
+copyright = '2016, JRyannel'
+author = 'JRyannel'
+
+# 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 = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+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.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# 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 = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- 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 = 'alabaster'
+
+# 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.
+# "<project> v<release> documentation" by default.
+#
+# html_title = 'QFace v1.0'
+
+# 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 (relative to this directory) to use as a 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#
+# html_extra_path = []
+
+# If not None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+#
+# html_last_updated_fmt = None
+
+# 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 = True
+
+# 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 = True
+
+# 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 = True
+
+# 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
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
+#
+# html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#
+# html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#
+# html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'QFacedoc'
+
+# -- 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': '',
+
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'QFace.tex', 'QFace Documentation',
+ 'JRyannel', '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 = []
+
+# It false, will not define \strong, \code, itleref, \crossref ... but only
+# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
+# packages.
+#
+# latex_keep_old_macro_names = True
+
+# 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 = [
+ (master_doc, 'qface', 'QFace Documentation',
+ [author], 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 = [
+ (master_doc, 'QFace', 'QFace Documentation',
+ author, 'QFace', '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'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#
+# texinfo_no_detailmenu = False
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# The basename for the epub file. It defaults to the project name.
+# epub_basename = project
+
+# The HTML theme for the epub output. Since the default themes are not
+# optimized for small screen space, using the same theme for HTML and epub
+# output is usually not wise. This defaults to 'epub', a theme designed to save
+# visual space.
+#
+# epub_theme = 'epub'
+
+# 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 = ()
+
+# A sequence of (type, uri, title) tuples for the guide element of content.opf.
+#
+# epub_guide = ()
+
+# 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 that 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 = ['search.html']
+
+# The depth of the table of contents in toc.ncx.
+#
+# epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#
+# epub_tocdup = True
+
+# Choose between 'default' and 'includehidden'.
+#
+# epub_tocscope = 'default'
+
+# Fix unsupported image types using the Pillow.
+#
+# epub_fix_images = False
+
+# Scale large images.
+#
+# epub_max_image_width = 0
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#
+# epub_show_urls = 'inline'
+
+# If false, no index is generated.
+#
+# epub_use_index = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+
diff --git a/docs/domain.md b/docs/domain.rst
index f6e9b5f..a3b5311 100644
--- a/docs/domain.md
+++ b/docs/domain.rst
@@ -1,12 +1,14 @@
-# Domain Model
+Domain Model
+============
The domain model resembles the structure of our system as objects. It is build by the parser and is the input into the generator.
It is important to understand the domain model as it is the main input for the template generation.
-The IDL is converted into an in memory domain model (see qface/idl/domain.py).
+The IDL is converted into an in memory domain model (see qface/idl/domain.py)
+
+.. code-block:: yaml
-```yaml
- System
- Module
- Import
@@ -17,39 +19,41 @@ The IDL is converted into an in memory domain model (see qface/idl/domain.py).
- Enum
- Flag
- Struct
-```
+
The domain model is the base for the code generation. You traverse the domain tree and trigger your own code generation.
-```python
-from qface.generator import FileSystem
+.. code-block:: python
+ from qface.generator import FileSystem
+
+ system = FileSystem.parse_dir('interfaces')
-system = FileSystem.parse_dir('interfaces')
+ for module in sytem.modules:
+ print(module.name)
-for module in sytem.modules:
- print(module.name)
+ for interfaces in module.interfaces:
+ print(interfaces.name)
- for interfaces in module.interfaces:
- print(interfaces.name)
+ for struct in module.structs:
+ print(struct.name)
- for struct in module.structs:
- print(struct.name)
-```
-# Debug
+Debug
+-----
At any time you can place a debug breakpoint:
-```python
-import ipdb; ipd.set_trace()
-```
+.. code-block:: python
+
+ import ipdb; ipd.set_trace()
+
See https://pypi.python.org/pypi/ipdb
To see the object members just use:
-```python
-dir(module) # list all members of module
-help(module) # prints the documentation
-```
+.. code-block:: python
+
+ dir(module) # list all members of module
+ help(module) # prints the documentation
diff --git a/docs/extending.md b/docs/extending.md
deleted file mode 100644
index 163ae6a..0000000
--- a/docs/extending.md
+++ /dev/null
@@ -1,45 +0,0 @@
-# Extending QFace
-
-QFace is easy to use and easy to extend. Your generator is just a small python script using the qface library.
-
-The script iterates over the domain model and writes files using a template language.
-
-See template engine documentation:
-
-* http://jinja.pocoo.org
-* http://jinja.pocoo.org/docs/dev/templates
-
-
-```python
-from qface.generator import FileSystem, Generator
-
-def generate(input, output):
- # parse the interface files
- system = FileSystem.parse_dir(input)
- # setup the generator
- generator = Generator(searchpath='templates')
- # create a context object
- ctx = {'output': output, 'system': system}
- # apply the context on the template and write the output to file
- generator.write('{{output}}/modules.csv', 'modules.csv', ctx)
-```
-
-This script reads the input directory returns a system object from the domain model. This is used as the root object for the code generation inside the template.
-
-Below is a simple template which geenrates a CSV document of all interfaces, structs and enums.
-
-```jinja
-{% for module in system.modules %}
- {%- for interface in module.interfaces -%}
- INTERFACE, {{module}}.{{interface}}
- {% endfor -%}
- {%- for struct in module.structs -%}
- STRUCT , {{module}}.{{struct}}
- {% endfor -%}
- {%- for enum in module.enums -%}
- ENUM , {{module}}.{{enum}}
- {% endfor -%}
-{% endfor %}
-```
-
-The template iterates over the domain objects and generates text which is written into a file. The file name is also adjustable using the same template language.
diff --git a/docs/extending.rst b/docs/extending.rst
new file mode 100644
index 0000000..c80bdd2
--- /dev/null
+++ b/docs/extending.rst
@@ -0,0 +1,47 @@
+===============
+Extending QFace
+===============
+
+QFace is easy to use and easy to extend. Your generator is just a small python script using the qface library.
+
+The script iterates over the domain model and writes files using a template language.
+
+See template engine documentation:
+
+* http://jinja.pocoo.org
+* http://jinja.pocoo.org/docs/dev/templates
+
+
+.. code-block:: python
+
+ from qface.generator import FileSystem, Generator
+
+ def generate(input, output):
+ # parse the interface files
+ system = FileSystem.parse_dir(input)
+ # setup the generator
+ generator = Generator(searchpath='templates')
+ # create a context object
+ ctx = {'output': output, 'system': system}
+ # apply the context on the template and write the output to file
+ generator.write('{{output}}/modules.csv', 'modules.csv', ctx)
+
+This script reads the input directory returns a system object from the domain model. This is used as the root object for the code generation inside the template.
+
+Below is a simple template which geenrates a CSV document of all interfaces, structs and enums.
+
+.. code-block:: jinja
+
+ {% for module in system.modules %}
+ {%- for interface in module.interfaces -%}
+ INTERFACE, {{module}}.{{interface}}
+ {% endfor -%}
+ {%- for struct in module.structs -%}
+ STRUCT , {{module}}.{{struct}}
+ {% endfor -%}
+ {%- for enum in module.enums -%}
+ ENUM , {{module}}.{{enum}}
+ {% endfor -%}
+ {% endfor %}
+
+The template iterates over the domain objects and generates text which is written into a file. The file name is also adjustable using the same template language.
diff --git a/docs/grammar.md b/docs/grammar.md
deleted file mode 100644
index 214aada..0000000
--- a/docs/grammar.md
+++ /dev/null
@@ -1,106 +0,0 @@
-# QDL grammar
-
-QDL (Qt definnition language) is an IDL to define an interface. In general it is modeled to define an interface between Qt QML and C++. The QDL syntax is flexible enough also to be used in other context.
-
-```html
-module <module> <version>
-import <module> <version>
-
-interface <Identifier> {
- <type> <identifier>
- <type> <operation>(<parameter>*)
- event <type> <event>(<parameter>*)
-}
-
-struct <Identifier> {
- <type> <identifier>;
-}
-
-enum <Identifier> {
- <name> = <value>,
-}
-
-flag <Identifier> {
- <name> = <value>,
-}
-```
-
-A QDL document always describes one module. Each document can contain one or more interfaces, structs, flags or enums. Each document can import other modules using the import statement.
-
-
-## Module
-
-A module is identified name. A module should be normally a URI where all parts are lowercase (e.g. `entertainment.tuner`). A module can import other modules. This is used to ensure that dependencies are declared inside the QDL file.
-
-## Types
-
-Types are either local and can be references simply by its name, or they are from external module in this case they need to be referenced with the fully qualified name (`module + '.' + name`). A type can be an interface, struct, enum or flag.
-
-A module consist of either one or more interfaces, structs and enums/flags. They can come in any number or combination. The interface is the only type which can contain operations and events. The struct is merely a container to transport structured data. An enum/flag allows the user to encode information used inside the struct or interface as datatype.
-
-The QDL does not allow to extend interfaces. It is by design kept simple.
-
-Below is an example of a QDL file.
-
-```javascript
-module entertainment.tuner 1.0;
-
-import common 1.0
-
-/*! Service Tuner */
-interface Tuner {
- /*! property currentStation */
- readonly Station currentStation;
- /*! operation nextStation */
- void nextStation();
- /*! operation previousStation */
- void previousStation();
- /*! operation updateCurrentStation */
- void updateCurrentStation(int stationId);
-
- list<int> primitiveList;
- list<Station> complexList;
- model<int> primitiveModel;
- model<Station> complexModel;
-}
-
-/*! enum State */
-enum State {
- /*! value State.Null */
- Null=0,
- /*! value State.Loading */
- Loading=1,
- /*! value State.Ready */
- Ready=2,
- /*! value State.Error */
- Error=3
-}
-
-/*! enum Waveband */
-enum Waveband {
- /*! value Waveband.FM */
- FM=0,
- /*! value Waveband.AM */
- AM=1
-}
-
-flag Features {
- Mono = 0x1,
- Stereo = 0x2,
-}
-
-/*! struct Station */
-struct Station {
- /*! member stationId */
- int stationId;
- /*! member name */
- string name;
- /*! last time modified */
- common.TimeStamp modified;
-}
-```
-
-
-
-
-
diff --git a/docs/grammar.rst b/docs/grammar.rst
new file mode 100644
index 0000000..1998025
--- /dev/null
+++ b/docs/grammar.rst
@@ -0,0 +1,111 @@
+===========
+QDL Grammar
+===========
+
+QDL (Qt definition language) is an IDL to define an interface. In general it is modeled to define an interface between Qt QML and C++. The QDL syntax is flexible enough also to be used in other context.
+
+.. code-block:: html
+
+ module <module> <version>
+ import <module> <version>
+
+ interface <Identifier> {
+ <type> <identifier>
+ <type> <operation>(<parameter>*)
+ event <type> <event>(<parameter>*)
+ }
+
+ struct <Identifier> {
+ <type> <identifier>;
+ }
+
+ enum <Identifier> {
+ <name> = <value>,
+ }
+
+ flag <Identifier> {
+ <name> = <value>,
+ }
+
+A QDL document always describes one module. Each document can contain one or more interfaces, structs, flags or enums. Each document can import other modules using the import statement.
+
+
+Module
+======
+
+A module is identified name. A module should be normally a URI where all parts are lowercase (e.g. `entertainment.tuner`). A module can import other modules. This is used to ensure that dependencies are declared inside the QDL file.
+
+Types
+-----
+
+Types are either local and can be references simply by its name, or they are from external module in this case they need to be referenced with the fully qualified name (``module + '.' + name``). A type can be an interface, struct, enum or flag.
+
+A module consist of either one or more interfaces, structs and enums/flags. They can come in any number or combination. The interface is the only type which can contain operations and events. The struct is merely a container to transport structured data. An enum/flag allows the user to encode information used inside the struct or interface as datatype.
+
+The QDL does not allow to extend interfaces. It is by design kept simple.
+
+Below is an example of a QDL file.
+
+.. code-block:: js
+
+ module entertainment.tuner 1.0;
+
+ import common 1.0
+
+ /*! Service Tuner */
+ interface Tuner {
+ /*! property currentStation */
+ readonly Station currentStation;
+ /*! operation nextStation */
+ void nextStation();
+ /*! operation previousStation */
+ void previousStation();
+ /*! operation updateCurrentStation */
+ void updateCurrentStation(int stationId);
+
+ list<int> primitiveList;
+ list<Station> complexList;
+ model<int> primitiveModel;
+ model<Station> complexModel;
+ }
+
+ /*! enum State */
+ enum State {
+ /*! value State.Null */
+ Null=0,
+ /*! value State.Loading */
+ Loading=1,
+ /*! value State.Ready */
+ Ready=2,
+ /*! value State.Error */
+ Error=3
+ }
+
+ /*! enum Waveband */
+ enum Waveband {
+ /*! value Waveband.FM */
+ FM=0,
+ /*! value Waveband.AM */
+ AM=1
+ }
+
+ flag Features {
+ Mono = 0x1,
+ Stereo = 0x2,
+ }
+
+ /*! struct Station */
+ struct Station {
+ /*! member stationId */
+ int stationId;
+ /*! member name */
+ string name;
+ /*! last time modified */
+ common.TimeStamp modified;
+ }
+
+
+
+
+
+
diff --git a/docs/welcome.md b/docs/index.rst
index aee804c..562dbd8 100644
--- a/docs/welcome.md
+++ b/docs/index.rst
@@ -1,11 +1,23 @@
-# Welcome
+QFace
+=====
QFace is a flexible Qt API generator. It uses a common IDL format (called qdl) to define an API. QFace comes with a set of predefined generators to generate QML Plugins. QFace can be easily extended with your own generator.
+.. toctree::
+ :maxdepth: 1
+
+ usage
+ grammar
+ domain
+ extending
+ builtin
+ api
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
-* [API](api.md)
-* [Domain](domain.md)
-* [Extending](extending.md)
-* [Grammar](grammar.md)
-* [Usage](usage.md)
-* [Builtin](builtin.md) \ No newline at end of file
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..bc3964e
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,281 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :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. epub3 to make an epub3
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. text to make text files
+ echo. man to make manual pages
+ echo. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. xml to make Docutils-native XML files
+ echo. pseudoxml to make pseudoxml-XML files for display purposes
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ echo. coverage to run coverage check of the documentation if enabled
+ echo. dummy to check syntax errors of document sources
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+
+REM Check if sphinx-build is available and fallback to Python version if any
+%SPHINXBUILD% 1>NUL 2>NUL
+if errorlevel 9009 goto sphinx_python
+goto sphinx_ok
+
+:sphinx_python
+
+set SPHINXBUILD=python -m sphinx.__init__
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+:sphinx_ok
+
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\QFace.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\QFace.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "epub3" (
+ %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "latexpdf" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ cd %BUILDDIR%/latex
+ make all-pdf
+ cd %~dp0
+ echo.
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "latexpdfja" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ cd %BUILDDIR%/latex
+ make all-pdf-ja
+ cd %~dp0
+ echo.
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+if "%1" == "coverage" (
+ %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of coverage in the sources finished, look at the ^
+results in %BUILDDIR%/coverage/python.txt.
+ goto end
+)
+
+if "%1" == "xml" (
+ %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The XML files are in %BUILDDIR%/xml.
+ goto end
+)
+
+if "%1" == "pseudoxml" (
+ %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
+ goto end
+)
+
+if "%1" == "dummy" (
+ %SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. Dummy builder generates no files.
+ goto end
+)
+
+:end
diff --git a/docs/usage.md b/docs/usage.md
deleted file mode 100644
index d45669d..0000000
--- a/docs/usage.md
+++ /dev/null
@@ -1,117 +0,0 @@
-# Usage
-
-QFace requires one or more IDL files as input file and a generator to produce output files. The IDL files are named QDL (Qt definition language).
-
-There is a central client to interface the commands for generation, called cli.
-
-To use an existing generator just provide the path to the generator script.
-
-![concept](qface_concept.png)
-
-```sh
-./cli.py generator --generator generator/csv --input input --output output
-```
-
-You can also create a YAML configuration file (e.g csv.yaml):
-
-```yaml
-generator: generator/csv
-input: input
-output: output
-```
-
-And then call the client with:
-
-```sh
-./cli.py generate --runner csv.yaml
-```
-
-To enable auto-live reloading just use the monitor target:
-
-
-```sh
-./cli.py generator_monitor --runner csv.yaml
-```
-
-This will observe the generator folder and the input folder for changes and re-run the generator.
-
-## Grammar
-
-The IDL grammar is described in the grammar file (see qface/parser/idl/T.g4)
-
-```html
- module <identifier> <version>;
-
- [import <identifier> <version>];
-
- interface <identifier> {
- (readonly) <type> <property>;
- <type> <operation>([type name]);
- event <type> <operation>([type name]);
- list<type> <property>;
- model<type> <property>;
- }
-
- enum <identifier> {
- <name> = <value>
- }
-
- flag <identifier> {
- <name> = <value>
- }
-
- struct <identifier> {
- <type> <name>;
- }
-```
-
-## Domain Model
-
-The IDL is converted into an in memory domain model (see qface/idl/domain.py).
-
-```yaml
- - System
- - Module
- - Import
- - Service
- - Property
- - Operation
- - Event
- - Enum
- - Flag
- - Struct
-```
-
-The domain model is the base for the code generation.
-
-## Code Generation
-
-The code generation is driven by a small script which iterates over the domain model and writes files using a template language (see http://jinja.pocoo.org) and espcially the template designer documentation (http://jinja.pocoo.org/docs/dev/templates/).
-
-```python
-from qface.generator import FileSystem, Generator
-
-def generate(input, output):
- system = FileSystem.parse_dir(input)
- generator = Generator(searchpath='templates')
- ctx = {'output': output, 'system': system}
- generator.write('{{output}}/modules.csv', 'modules.csv', ctx)
-```
-
-This script reads the input directory returns a system object form the domain model. This is used as the root object for the code generation inside the template language.
-
-```jinja
- {% for module in system.modules %}
- {%- for interface in module.interfaces -%}
- SERVICE, {{module}}.{{interface}}
- {% endfor -%}
- {%- for struct in module.structs -%}
- STRUCT , {{module}}.{{struct}}
- {% endfor -%}
- {%- for enum in module.enums -%}
- ENUM , {{module}}.{{enum}}
- {% endfor -%}
- {% endfor %}
-```
-
-The template iterates over the domain objects and generates text which is written into a file. The file name is also adjustable using the same template language.
diff --git a/docs/usage.rst b/docs/usage.rst
new file mode 100644
index 0000000..7c4d78d
--- /dev/null
+++ b/docs/usage.rst
@@ -0,0 +1,102 @@
+=====
+Usage
+=====
+
+Concept
+=======
+
+QFace requires one or more IDL files as input file and a generator to produce output files. The IDL files are named QDL (Qt definition language).
+
+.. image:: qface_concept.png
+
+There are several ways to call the generator.
+
+
+Invokation
+==========
+
+Direct Invokation
+-----------------
+
+You can call the generator directly by using the provided script. All generator should at minimum expect a series of inputs and one output path. This is normally recommended for production.
+
+.. code-block:: sh
+
+ ./csvgen.py input output
+
+Via qface invokation
+--------------------
+
+You can invoke your generator using the qface helper script. This allows you also to use some specific developer support. It is recommended way during generator development.
+
+To use an existing generator just provide the path to the generator script.
+
+.. code-block:: sh
+
+ qface generate --generator ./csvgen.py input output
+
+
+To suse live reloading on changes just use the reload option:
+
+
+.. code-block:: sh
+
+ qface generate --generator ./csvgen.py input output --reload
+
+This will observe the generator folder and the input folder for changes and re-run the generator.
+
+Configuration Invokation
+------------------------
+
+You can also create a YAML configuration file (for example csv.yaml):
+
+
+.. code-block:: yaml
+
+ generator: ./csvgen.py
+ input: input
+ output: output
+ reload: false
+
+
+And then call the client with:
+
+.. code-block:: sh
+
+ qface generate --config csv.yaml
+
+
+
+Code Generation Principle
+=========================
+
+The code generation is driven by a small script which iterates over the domain model and writes files using a template language (see http://jinja.pocoo.org) and espcially the template designer documentation (http://jinja.pocoo.org/docs/dev/templates/).
+
+.. code-block:: python
+
+ from qface.generator import FileSystem, Generator
+
+ def generate(input, output):
+ system = FileSystem.parse_dir(input)
+ generator = Generator(searchpath='templates')
+ ctx = {'output': output, 'system': system}
+ generator.write('{{output}}/modules.csv', 'modules.csv', ctx)
+
+
+This script reads the input directory returns a system object form the domain model. This is used as the root object for the code generation inside the template language.
+
+.. code-block:: jinja
+
+ {% for module in system.modules %}
+ {%- for interface in module.interfaces -%}
+ SERVICE, {{module}}.{{interface}}
+ {% endfor -%}
+ {%- for struct in module.structs -%}
+ STRUCT , {{module}}.{{struct}}
+ {% endfor -%}
+ {%- for enum in module.enums -%}
+ ENUM , {{module}}.{{enum}}
+ {% endfor -%}
+ {% endfor %}
+
+The template iterates over the domain objects and generates text which is written into a file. The file name is also adjustable using the same template language.