* First pass at reorganizing the documentation

        For OpenAADL#171

doc/about.rst

@@ -1,5 +1,3 @@
-
-
 .. _about:
 
 ================
@@ -65,4 +63,3 @@ Copyright Information
 If you have any questions regarding this document, its
 copyright, or publishing this document in non-electronic form,
 please contact us.
-

doc/conf.py

@@ -261,7 +261,7 @@ def get_version():
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
   ('index', 'ocarina.tex', u'Ocarina Documentation',
-   u'Jerome Hugues', 'manual'),
+   u'Julien Delange, Jerome Hugues, Bechir Zalila', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -320,4 +320,11 @@ def get_version():
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None}
+intersphinx_mapping = {'https://docs.python.org/': None}
+
+
+def setup(sphinx):
+    sys.path.append(os.path.abspath('.'))
+    sys.path.append(os.path.abspath('./util/'))
+    from AADLLexer import AADLLexer
+    sphinx.add_lexer("aadl", AADLLexer())

doc/index.rst

@@ -14,11 +14,11 @@ Ocarina User's Guide
    introduction
    installation
    usage
+   scenario
+   polyorb-hi-c
    osate-ocarina
    python
    editors
-   bug
+   ocarina_config
    gfdl
    annexes
-
-

doc/installation.rst

@@ -47,7 +47,7 @@ Optional components:
 Semi-automated build instructions
 #################################
 
-The `ocarina-build https://github.com/OpenAADL/ocarina-build/`_
+The `ocarina-build <https://github.com/OpenAADL/ocarina-build/>`_
 repository proposes a script, `build_ocarina.sh`, to get source code,
 compile and test Ocarina.
 

doc/introduction.rst

@@ -1,4 +1,3 @@
-
 .. _introduction:
 
 ============
@@ -169,3 +168,16 @@ a complete model.
    :align: center
 
    ASSERT MPC Case study
+
+Ocarina concepts
+################
+
+Ocarina uses the following set of definitions :
+
+.. index:: scenario files
+
+* A *scenario file* is a specific AADL system that controls the behavior of Ocarina through various properties, see :ref:`scenariofiles`.
+
+.. index:: root system
+
+* A *root system* is the root of an AADL model; it is a system implementation without feature. As a closed system, it has definitions required for complete processing by Ocarina: processors, threads, processes, etc.

doc/ocarina_config.rst

@@ -0,0 +1,17 @@
+=====================
+Ocarina property sets
+=====================
+
+Deployment
+##########
+
+.. literalinclude:: ../resources/deployment.aadl
+   :language: aadl
+
+.. _ocarina_config:
+
+Ocarina_Config
+##############
+
+.. literalinclude:: ../resources/ocarina_config.aadl
+   :language: aadl