Skip to content

Commit

Permalink
Fixed PyCharm auto-format on ReST files
Browse files Browse the repository at this point in the history
  • Loading branch information
tcalmant committed Jan 18, 2017
1 parent 82d9fdf commit fade72b
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 37 deletions.
2 changes: 1 addition & 1 deletion docs/tutorials/index.rst
Expand Up @@ -8,4 +8,4 @@ This section provides tutorials for various parts of iPOPO.
.. toctree::
:maxdepth: 2

ipopo_10min
ipopo_10min
57 changes: 29 additions & 28 deletions docs/tutorials/ipopo_10min.rst
Expand Up @@ -5,11 +5,11 @@ iPOPO in 10 minutes

:Authors: Shadi Abras, Thomas Calmant

This tutorial presents how to use the iPOPO framework and its associated
service-oriented component model.
The concepts of the service-oriented component model are introduced, followed
by a simple example that demonstrates the features of iPOPO.
This framework uses decorators to describe components.
This tutorial presents how to use the iPOPO framework and its associated
service-oriented component model.
The concepts of the service-oriented component model are introduced, followed
by a simple example that demonstrates the features of iPOPO.
This framework uses decorators to describe components.

Introduction
============
Expand Down Expand Up @@ -52,6 +52,7 @@ It also defines three major concepts:
iPOPO to manage the components.
Components are defined inside bundles.


Simple example
==============

Expand All @@ -76,11 +77,11 @@ application. Three bundles compose this application:
line interface.

.. image:: /_static/tutorials/spell_checker/spellchecker_arch.svg
:align: center
:align: center
:alt: Service hierarchy
:scale: 100%
:scale: 100%

The spell dictionary components provide the ``spell_dictionary_service``
The spell dictionary components provide the ``spell_dictionary_service``
specification.
The spell checker provides a ``spell_checker_service`` specification.

Expand Down Expand Up @@ -118,10 +119,10 @@ The ``spell_dictionary_EN`` bundle is a simple implementation of the Dictionary
service. It contains few English words.

.. literalinclude:: /_static/tutorials/spell_checker/spell_dictionary_EN.py
:language: python
:linenos:
:language: python
:linenos:

* The ``@Component`` decorator is used to declare an iPOPO component.
* The ``@Component`` decorator is used to declare an iPOPO component.
It must always be on top of other decorators.
* The ``@Provides`` decorator indicates that the component provides a service.
* The ``@Instantiate`` decorator instructs iPOPO to automatically create an
Expand All @@ -145,14 +146,14 @@ one. It only differs in the ``language`` component property, as it checks some
French words declared during component validation.

.. literalinclude:: /_static/tutorials/spell_checker/spell_dictionary_FR.py
:language: python
:linenos:
:emphasize-lines: 14,18,20,31-40
:language: python
:linenos:
:emphasize-lines: 14,18,20,31-40

It is important to note that the iPOPO factory name must be unique in a
framework: only the first one to be registered with a given name will be taken
into account.
The name of component instances follows the same rule.
It is important to note that the iPOPO factory name must be unique in a
framework: only the first one to be registered with a given name will be taken
into account.
The name of component instances follows the same rule.


The spell checker bundle: Requiring a service
Expand All @@ -165,10 +166,10 @@ During this step, we will create an iPOPO component requiring a Dictionary
service and providing the Spell Checker service.

.. literalinclude:: /_static/tutorials/spell_checker/spell_checker.py
:language: python
:linenos:
:language: python
:linenos:

* The ``@Requires`` decorator specifies a service dependency.
* The ``@Requires`` decorator specifies a service dependency.
This required service is injected in a local variable in this bundle.
Its ``aggregate`` attribute tells iPOPO to collect the list of services
providing the required specification, instead of the first one.
Expand All @@ -185,12 +186,12 @@ The ``spell_client`` bundle contains a very simple user interface allowing a
user to interact with a spell checker service.

.. literalinclude:: /_static/tutorials/spell_checker/spell_client.py
:language: python
:linenos:
:language: python
:linenos:

The component defined here implements and provides a shell command service,
which will be consumed by the Pelix Shell Core Service.
It registers a ``spell`` shell command.
The component defined here implements and provides a shell command service,
which will be consumed by the Pelix Shell Core Service.
It registers a ``spell`` shell command.


Main script: Launching the framework
Expand All @@ -200,8 +201,8 @@ We have all the bundles required to start playing with the application.
To run the example, we have to start Pelix, then all the required bundles.

.. literalinclude:: /_static/tutorials/spell_checker/main_pelix_launcher.py
:language: python
:linenos:
:language: python
:linenos:


Running the application
Expand Down
16 changes: 8 additions & 8 deletions docs/users.rst
Expand Up @@ -11,9 +11,9 @@ Cohorte Technologies (isandlaTech)
==================================

.. image:: /_static/users/cohorte_technologies.svg
:alt: Cohorte Techologies
:alt: Cohorte Techologies
:width: 33%
:target: http://cohorte-technologies.com/
:target: http://cohorte-technologies.com/

`Cohorte Technologies <http://cohorte-technologies.com/>`_ is the main sponsor
and user of iPOPO.
Expand All @@ -25,15 +25,15 @@ G2ELab / G-Scop
===============

.. image:: /_static/users/logo_g2elab.jpg
:alt: G2ELab
:alt: G2ELab
:target: http://www.g2elab.grenoble-inp.fr/
:width: 33%

.. image:: /_static/users/logo_gscop.jpg
:alt: G2ELab
:alt: G2ELab
:target: http://www.g-scop.grenoble-inp.fr/
:width: 33%
:align: right
:align: right


`PREDIS <http://www.g2elab.grenoble-inp.fr/plateformes/plateforme-predis-196107.kjsp>`_
Expand Down Expand Up @@ -63,15 +63,15 @@ Polytech Grenoble / AIR
=======================

.. image:: /_static/users/logo_polytech.png
:alt: Polytech Grenoble
:alt: Polytech Grenoble
:target: http://www.polytech-grenoble.fr/
:width: 33%

.. image:: /_static/users/logo_air_1.png
:alt: Ambient Intelligence Room
:alt: Ambient Intelligence Room
:target: http://air.imag.fr/
:width: 15%
:align: right
:align: right

`AIR <http://air.imag.fr/>`_ means Ambient Intelligence Room.

Expand Down

0 comments on commit fade72b

Please sign in to comment.