Skip to content

Commit c5c5880

Browse files
committed
[documentation] update doc
1 parent 5d394a3 commit c5c5880

File tree

9 files changed

+30
-7
lines changed

9 files changed

+30
-7
lines changed

.travis.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ python:
44
- "3.2"
55

66
# command to install dependencies
7-
install: pip install -r requirements_python`python version.py`.txt --use-mirrors
7+
install:
8+
- pip install -r requirements_python`python version.py`.txt --use-mirrors
89

910
# command to run tests
1011
script: nosetests && sphinx-build -nW -b html -d docs/_build/doctrees docs docs/_build/html

docs/extra/event-dispatcher.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ Event Dispatcher
44

55
The IoC package includes a small event dispatcher, you can include it by adding this yaml.
66

7+
Configuration
8+
~~~~~~~~~~~~~
9+
710
.. code-block:: yaml
811
912
ioc.extra.event:

docs/extra/flask.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ Flask
33

44
Flask_ is a web micro framework
55

6+
Configuration
7+
~~~~~~~~~~~~~
8+
69
.. code-block:: yaml
710
811
ioc.extra.flask:
@@ -41,6 +44,8 @@ Flask_ is a web micro framework
4144
blueprints:
4245
- element.flask.blueprint
4346
47+
Services available
48+
~~~~~~~~~~~~~~~~~~
4449

4550
Services available:
4651

docs/extra/mailer.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Mailer
22
------
33

4+
Configuration
5+
~~~~~~~~~~~~~
6+
47
.. code-block:: yaml
58
69
ioc.extra.mailer:

docs/extra/redis-py.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ Redis-Py
33

44
Redis-Py_ is an interface to the Redis_ key-value store.
55

6+
Configuration
7+
~~~~~~~~~~~~~
8+
69
.. code-block:: yaml
710
811
ioc.extra.redis:
@@ -21,7 +24,9 @@ Redis-Py_ is an interface to the Redis_ key-value store.
2124
encoding_errors: 'strict'
2225
decode_responses: false
2326
24-
Services available:
27+
Services available
28+
~~~~~~~~~~~~~~~~~~
29+
2530

2631
- ioc.extra.redis.manager: the Redis manager to retrieve client and connection
2732
- ioc.extra.redis.connection.default: the ``default`` connection

docs/extra/redis-wrap.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ redis_wrap
33

44
redis-wrap_ implements a wrapper for Redis datatypes so they mimic the datatypes found in Python
55

6+
Configuration
7+
~~~~~~~~~~~~~
8+
69
.. code-block:: yaml
710
811
ioc.extra.redis_wrap:

docs/extra/twisted.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
Twisted
22
-------
33

4+
Configuration
5+
~~~~~~~~~~~~~
6+
47
Twisted_ is an event-driven networking engine written.
58

69
.. code-block:: yaml
710
811
ioc.extra.twisted:
912
10-
Services available:
13+
Services available
14+
~~~~~~~~~~~~~~~~~~
1115

1216
- ioc.extra.twisted.reactor: the reactor instance
1317
- ioc.extra.twisted.reactor.thread_pool: the reactor thread pool

docs/references/bootstraping.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Bootstraping
2-
============
1+
Bootstrapping
2+
=============
33

4-
Here a quick exemple on how to use the ioc to initialize a project.
4+
Here a quick example on how to use the ioc to initialize a project.
55

66
First, create a ``start.py`` file with the following code.
77

docs/references/extension.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ and to use it:
5151

5252
.. code-block:: python
5353
54-
5554
import ioc
5655
5756
container = ioc.build(['config.yml'])

0 commit comments

Comments
 (0)