Skip to content

Commit 3688e9f

Browse files
randerande
committed
[documentation] refactor and validate documentation
1 parent bfec939 commit 3688e9f

File tree

14 files changed

+150
-143
lines changed

14 files changed

+150
-143
lines changed

‎docs/extra.rst‎

Lines changed: 4 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,139 +1,10 @@
11
Extra
22
=====
33

4-
The ioc package include some integration with python lib, just edit the ``config.yml`` file and add the different following ``yaml`` sections.
4+
The ioc package include some integration with some python libs, just edit the ``config.yml`` file and add the different following ``yaml`` sections.
55

6-
Flask
7-
-----
6+
.. toctree::
7+
:glob:
88

9-
Flask_ is a web micro framework
9+
extra/*
1010

11-
.. code-block:: yaml
12-
13-
ioc.extra.flask:
14-
app:
15-
port: 8080
16-
name: ''
17-
static_path: ''
18-
static_url_path: ''
19-
static_folder: 'static'
20-
template_folder: 'templates'
21-
instance_path: ''
22-
instance_relative_config: false
23-
24-
config: # use to populate the instance_relative_config kwargs
25-
DEBUG: False
26-
TESTING: False
27-
PROPAGATE_EXCEPTIONS:
28-
PRESERVE_CONTEXT_ON_EXCEPTION:
29-
SECRET_KEY:
30-
USE_X_SENDFILE: False
31-
LOGGER_NAME:
32-
SERVER_NAME:
33-
APPLICATION_ROOT:
34-
SESSION_COOKIE_NAME: 'session'
35-
SESSION_COOKIE_DOMAIN:
36-
SESSION_COOKIE_PATH:
37-
SESSION_COOKIE_HTTPONLY: True
38-
SESSION_COOKIE_SECURE: False
39-
MAX_CONTENT_LENGTH:
40-
SEND_FILE_MAX_AGE_DEFAULT: 43200
41-
TRAP_BAD_REQUEST_ERRORS: False
42-
TRAP_HTTP_EXCEPTIONS: False
43-
PREFERRED_URL_SCHEME: 'http'
44-
JSON_AS_ASCII: True
45-
46-
blueprints:
47-
- element.flask.blueprint
48-
49-
50-
Services available:
51-
52-
- ioc.extra.flask.app : the Flask app
53-
54-
55-
Redis-Py
56-
--------
57-
58-
Redis-Py_ is an interface to the Redis_ key-value store.
59-
60-
.. code-block:: yaml
61-
62-
ioc.extra.redis:
63-
clients:
64-
default:
65-
connection: default
66-
67-
connections:
68-
default:
69-
host: 'localhost'
70-
port: 6379
71-
db: 0
72-
password:
73-
socket_timeout:
74-
encoding: 'utf-8'
75-
encoding_errors: 'strict'
76-
decode_responses: false
77-
78-
Services available:
79-
80-
- ioc.extra.redis.manager: the Redis manager to retrieve client and connection
81-
- ioc.extra.redis.connection.default: the ``default`` connection
82-
- ioc.extra.redis.client.default: the ``default`` client
83-
84-
85-
redis_wrap
86-
----------
87-
88-
redis-wrap_ implements a wrapper for Redis datatypes so they mimic the datatypes found in Python
89-
90-
.. code-block:: yaml
91-
92-
ioc.extra.redis_wrap:
93-
clients:
94-
default: ioc.extra.redis.client.default
95-
96-
Twisted
97-
-------
98-
99-
Twisted_ is an event-driven networking engine written.
100-
101-
.. code-block:: yaml
102-
103-
ioc.extra.twisted:
104-
105-
Services available:
106-
107-
- ioc.extra.twisted.reactor: the reactor instance
108-
- ioc.extra.twisted.reactor.thread_pool: the reactor thread pool
109-
110-
111-
Event Dispatcher
112-
----------------
113-
114-
The IoC package includes a small event dispatcher, you can include it by adding this yaml.
115-
116-
.. code-block:: yaml
117-
118-
ioc.extra.event:
119-
120-
Mailer
121-
------
122-
123-
.. code-block:: yaml
124-
125-
ioc.extra.mailer:
126-
host: localhost
127-
port:
128-
use_tls: false
129-
user:
130-
password:
131-
use_ssl: false
132-
133-
134-
.. _redis-wrap: https://github.com/Doist/redis_wrap
135-
.. _Flask: http://flask.pocoo.org/
136-
.. _Redis-Py: https://github.com/andymccurdy/redis-py
137-
.. _Redis: http://redis.io/
138-
.. _Twisted: http://twistedmatrix.com/
139-
.. _Mailer: https://pypi.python.org/pypi/mailer

‎docs/extra/event-dispatcher.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
Event Dispatcher
3+
----------------
4+
5+
The IoC package includes a small event dispatcher, you can include it by adding this yaml.
6+
7+
.. code-block:: yaml
8+
9+
ioc.extra.event:

‎docs/extra/flask.rst‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
Flask
2+
-----
3+
4+
Flask_ is a web micro framework
5+
6+
.. code-block:: yaml
7+
8+
ioc.extra.flask:
9+
app:
10+
port: 8080
11+
name: ''
12+
static_path: ''
13+
static_url_path: ''
14+
static_folder: 'static'
15+
template_folder: 'templates'
16+
instance_path: ''
17+
instance_relative_config: false
18+
19+
config: # use to populate the instance_relative_config kwargs
20+
DEBUG: False
21+
TESTING: False
22+
PROPAGATE_EXCEPTIONS:
23+
PRESERVE_CONTEXT_ON_EXCEPTION:
24+
SECRET_KEY:
25+
USE_X_SENDFILE: False
26+
LOGGER_NAME:
27+
SERVER_NAME:
28+
APPLICATION_ROOT:
29+
SESSION_COOKIE_NAME: 'session'
30+
SESSION_COOKIE_DOMAIN:
31+
SESSION_COOKIE_PATH:
32+
SESSION_COOKIE_HTTPONLY: True
33+
SESSION_COOKIE_SECURE: False
34+
MAX_CONTENT_LENGTH:
35+
SEND_FILE_MAX_AGE_DEFAULT: 43200
36+
TRAP_BAD_REQUEST_ERRORS: False
37+
TRAP_HTTP_EXCEPTIONS: False
38+
PREFERRED_URL_SCHEME: 'http'
39+
JSON_AS_ASCII: True
40+
41+
blueprints:
42+
- element.flask.blueprint
43+
44+
45+
Services available:
46+
47+
- ioc.extra.flask.app : the Flask app
48+
49+
50+
.. _Flask: http://flask.pocoo.org/

‎docs/extra/mailer.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Mailer
2+
------
3+
4+
.. code-block:: yaml
5+
6+
ioc.extra.mailer:
7+
host: localhost
8+
port:
9+
use_tls: false
10+
user:
11+
password:
12+
use_ssl: false
13+
14+
.. _Mailer: https://pypi.python.org/pypi/mailer

‎docs/extra/redis-py.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Redis-Py
2+
--------
3+
4+
Redis-Py_ is an interface to the Redis_ key-value store.
5+
6+
.. code-block:: yaml
7+
8+
ioc.extra.redis:
9+
clients:
10+
default:
11+
connection: default
12+
13+
connections:
14+
default:
15+
host: 'localhost'
16+
port: 6379
17+
db: 0
18+
password:
19+
socket_timeout:
20+
encoding: 'utf-8'
21+
encoding_errors: 'strict'
22+
decode_responses: false
23+
24+
Services available:
25+
26+
- ioc.extra.redis.manager: the Redis manager to retrieve client and connection
27+
- ioc.extra.redis.connection.default: the ``default`` connection
28+
- ioc.extra.redis.client.default: the ``default`` client
29+
30+
31+
.. _Redis-Py: https://github.com/andymccurdy/redis-py
32+
.. _Redis: http://redis.io/

‎docs/extra/redis-wrap.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
redis_wrap
2+
----------
3+
4+
redis-wrap_ implements a wrapper for Redis datatypes so they mimic the datatypes found in Python
5+
6+
.. code-block:: yaml
7+
8+
ioc.extra.redis_wrap:
9+
clients:
10+
default: ioc.extra.redis.client.default
11+
12+
13+
.. _redis-wrap: https://github.com/Doist/redis_wrap

‎docs/extra/twisted.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Twisted
2+
-------
3+
4+
Twisted_ is an event-driven networking engine written.
5+
6+
.. code-block:: yaml
7+
8+
ioc.extra.twisted:
9+
10+
Services available:
11+
12+
- ioc.extra.twisted.reactor: the reactor instance
13+
- ioc.extra.twisted.reactor.thread_pool: the reactor thread pool
14+
15+
16+
.. _Twisted: http://twistedmatrix.com/

‎docs/index.rst‎

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
.. IoC documentation master file, created by
2-
sphinx-quickstart on Fri Mar 29 01:43:00 2013.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
5-
61
Welcome to IoC's documentation!
72
===============================
83

@@ -12,12 +7,8 @@ Contents:
127
:maxdepth: 2
138

149
install
15-
bootstraping
16-
extension
17-
tag
18-
event_dispatcher
10+
references
1911
extra
20-
locator
2112

2213
Indices and tables
2314
==================

‎docs/references.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
References
2+
==========
3+
4+
.. toctree::
5+
:glob:
6+
7+
references/bootstraping
8+
references/extension
9+
references/tag
10+
references/locator
11+
references/event_dispatcher

docs/bootstraping.rst renamed to docs/references/bootstraping.rst

File renamed without changes.

0 commit comments

Comments
 (0)