Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Various documentation update.

  • Loading branch information...
commit 8e4297ceeaa0645cbc20b588f6d1d056a5261508 1 parent 1a70102
Thomas Mansencal authored

Showing 68 changed files with 683 additions and 1,372 deletions. Show diff stats Hide diff stats

  1. 2  .gitignore
  2. 10  CHANGES.rst
  3. 8  MANIFEST.in
  4. 127  README.rst
  5. 188  docs/help/Manager_Manual.html
  6. 138  docs/help/Manager_Manual.rst
  7. 3  docs/sphinx/source/index.rst
  8. 10  docs/sphinx/source/resources/pages/about.rst
  9. 51  docs/sphinx/source/resources/pages/api.rst
  10. 17  docs/sphinx/source/resources/pages/api/foundations.cache.rst
  11. 25  docs/sphinx/source/resources/pages/api/foundations.common.rst
  12. 60  docs/sphinx/source/resources/pages/api/foundations.core.rst
  13. 29  docs/sphinx/source/resources/pages/api/foundations.dataStructures.rst
  14. 24  docs/sphinx/source/resources/pages/api/foundations.environment.rst
  15. 116  docs/sphinx/source/resources/pages/api/foundations.exceptions.rst
  16. 12  docs/sphinx/source/resources/pages/api/foundations.globals.constants.rst
  17. 26  docs/sphinx/source/resources/pages/api/foundations.io.rst
  18. 21  docs/sphinx/source/resources/pages/api/foundations.library.rst
  19. 21  docs/sphinx/source/resources/pages/api/foundations.namespace.rst
  20. 25  docs/sphinx/source/resources/pages/api/foundations.nodes.rst
  21. 30  docs/sphinx/source/resources/pages/api/foundations.parsers.rst
  22. 17  docs/sphinx/source/resources/pages/api/foundations.pkzip.rst
  23. 17  docs/sphinx/source/resources/pages/api/foundations.rotatingBackup.rst
  24. 12  docs/sphinx/source/resources/pages/api/foundations.streamObject.rst
  25. 45  docs/sphinx/source/resources/pages/api/foundations.strings.rst
  26. 21  docs/sphinx/source/resources/pages/api/foundations.tcpServer.rst
  27. 10  docs/sphinx/source/resources/pages/api/foundations.tests.tests.rst
  28. 12  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCache.rst
  29. 41  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCommon.rst
  30. 32  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsCore.rst
  31. 24  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsDataStructures.rst
  32. 20  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsEnvironment.rst
  33. 21  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsExceptions.rst
  34. 12  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsGlobals.testsConstants.rst
  35. 33  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsIo.rst
  36. 25  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsLibrary.rst
  37. 20  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsNamespace.rst
  38. 20  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsNodes.rst
  39. 61  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsParsers.rst
  40. 21  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsPkzip.rst
  41. 21  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsRotatingBackup.rst
  42. 12  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsStreamObject.rst
  43. 72  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsStrings.rst
  44. 16  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsTcpServer.rst
  45. 19  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsUi.testsCommon.rst
  46. 35  docs/sphinx/source/resources/pages/api/foundations.tests.testsFoundations.testsWalkers.rst
  47. 12  docs/sphinx/source/resources/pages/api/foundations.tests.utilities.rst
  48. 21  docs/sphinx/source/resources/pages/api/foundations.ui.common.rst
  49. 21  docs/sphinx/source/resources/pages/api/foundations.walkers.rst
  50. 10  docs/sphinx/source/resources/pages/api/manager.tests.tests.rst
  51. 17  ...ources/pages/api/manager.tests.testsManager.resources.components.addons.testsComponentC.testsComponentC.rst
  52. 17  ...esources/pages/api/manager.tests.testsManager.resources.components.core.testsComponentA.testsComponentA.rst
  53. 17  ...esources/pages/api/manager.tests.testsManager.resources.components.core.testsComponentB.testsComponentB.rst
  54. 12  docs/sphinx/source/resources/pages/api/manager.tests.testsManager.testsComponent.rst
  55. 36  docs/sphinx/source/resources/pages/api/manager.tests.testsManager.testsComponentsManager.rst
  56. 17  docs/sphinx/source/resources/pages/api/manager.tests.testsManager.testsExceptions.rst
  57. 12  docs/sphinx/source/resources/pages/api/manager.tests.testsManager.testsGlobals.testsConstants.rst
  58. 12  docs/sphinx/source/resources/pages/api/manager.tests.testsManager.testsQObjectComponent.rst
  59. 21  docs/sphinx/source/resources/pages/api/manager.tests.testsManager.testsQWidgetComponent.rst
  60. 12  docs/sphinx/source/resources/pages/api/manager.tests.utilities.rst
  61. 33  docs/sphinx/source/resources/pages/changes.rst
  62. 13  docs/sphinx/source/resources/pages/installation.rst
  63. 2  docs/sphinx/source/resources/pages/introduction.rst
  64. 114  docs/sphinx/source/resources/pages/usage.rst
  65. 6  manager/globals/constants.py
  66. 41  setup.py
  67. 25  utilities/gatherFiles.sh
  68. 2  utilities/getDocumentation.sh
2  .gitignore
@@ -8,6 +8,8 @@
8 8
 *.pyc
9 9
 *.pyo
10 10
 
  11
+Manager.egg-info/
  12
+dist/
11 13
 docs/sphinx/build/
12 14
 docs/sphinx/source/resources/packages/
13 15
 releases/
10  CHANGES.rst
Source Rendered
... ...
@@ -1,4 +1,4 @@
1  
-Manager - 2.0.0 - Stable
  1
+Manager - 2.0.1 - Stable
2 2
 =========================
3 3
 
4 4
 .. .changes
@@ -6,6 +6,12 @@ Manager - 2.0.0 - Stable
6 6
 Changes
7 7
 =======
8 8
 
  9
+2.0.1 - Stable
  10
+--------------
  11
+
  12
+-  Updated package directory structure to be compliant with "Python Package Index".
  13
+-  Added documentation / Api files.
  14
+
9 15
 2.0.0 - Stable
10 16
 --------------
11 17
 
@@ -34,7 +40,7 @@ Changes
34 40
 About
35 41
 -----
36 42
 
37  
-| Manager by Thomas Mansencal – 2008 - 2012
  43
+| **Manager** by Thomas Mansencal – 2008 - 2012
38 44
 | Copyright© 2008 - 2012 – Thomas Mansencal – `thomas.mansencal@gmail.com <mailto:thomas.mansencal@gmail.com>`_
39 45
 | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/
40 46
 | `http://www.thomasmansencal.com/ <http://www.thomasmansencal.com/>`_
8  MANIFEST.in
... ...
@@ -0,0 +1,8 @@
  1
+include COPYING
  2
+include LICENSE
  3
+include *.rst
  4
+graft docs
  5
+graft utilities
  6
+recursive-exclude utilities *.pyc
  7
+graft manager/tests/testsManager/resources
  8
+recursive-exclude manager/tests/testsManager/resources *.pyc
127  README.rst
Source Rendered
... ...
@@ -1,24 +1,143 @@
1 1
 Manager
2 2
 =======
3 3
 
  4
+..  image:: https://secure.travis-ci.org/KelSolaar/Foundations.png?branch=master
  5
+
4 6
 Introduction
5 7
 ------------
6 8
 
7  
-Manager is the Components Manager package of `Umbra <https://github.com/KelSolaar/Umbra>`_, `sIBL_GUI <https://github.com/KelSolaar/sIBL_GUI>`_ and `sIBL_Reporter <https://github.com/KelSolaar/sIBL_Reporter>`_.
  9
+**Manager** is the Components Manager package of `Umbra <https://github.com/KelSolaar/Umbra>`_, `sIBL_GUI <https://github.com/KelSolaar/sIBL_GUI>`_ and `sIBL_Reporter <https://github.com/KelSolaar/sIBL_Reporter>`_. Components are simple python packages extending capabilities of their host application.
8 10
 
9 11
 Installation
10 12
 ------------
11 13
 
12  
-Manager depends on Foundations package available from Github: https://github.com/KelSolaar/Foundations. You will need to create some symbolic links from "Foundations/src/foundations" to "Manager/src/foundations", from "Foundations/src/tests/testsFoundations" to "Manager/src/tests/testsFoundations" or ensure the packages are available in Python path.
  14
+To install **Manager** from the `Python Package Index <http://pypi.python.org/pypi/Manager>`_ you can issue this command in a shell::
  15
+
  16
+	pip install Manager
  17
+
  18
+or this alternative command::
  19
+
  20
+	easy_install Manager
  21
+
  22
+Alternatively, if you want to directly install from `Github <http://github.com/KelSolaar/Manager>`_ source repository::
  23
+
  24
+	git clone git://github.com/KelSolaar/Manager.git
  25
+	python setup.py install
13 26
 
14 27
 Usage
15 28
 -----
16 29
 
  30
+Please refer to `Manager - Api <http://thomasmansencal.com/Sharing/Manager/Support/Documentation/Api/index.html>`_ for precise usage examples.
  31
+
  32
+A Component package contains at least a resource **.rc** description file and a main module::
  33
+
  34
+	testsComponentA
  35
+	├── __init__.py
  36
+	├── testsComponentA.py
  37
+	└── testsComponentA.rc
  38
+
  39
+The description file is a configuration style file with a structure similar to what you would find on Microsoft Windows INI files::
  40
+
  41
+	[Component]
  42
+	Name = core.testsComponentA
  43
+	Title = Tests Component A
  44
+	Module = testsComponentA
  45
+	Object = TestsComponentA
  46
+	Rank = 10
  47
+	Version = 1.0
  48
+
  49
+	[Informations]
  50
+	Author = Thomas Mansencal
  51
+	Email = thomas.mansencal@gmail.com
  52
+	Url = http://www.hdrlabs.com/
  53
+	Description = Core tests Component A.
  54
+
  55
+Given the following directories structure::
  56
+
  57
+	core
  58
+	├── __init__.py
  59
+	├── testsComponentA
  60
+	│   ├── __init__.py
  61
+	│   ├── testsComponentA.py
  62
+	│   └── testsComponentA.rc
  63
+	└── testsComponentB
  64
+		├── __init__.py
  65
+		├── testsComponentB.py
  66
+		└── testsComponentB.rc
  67
+
  68
+Instantiating the Components Manager is done the following way:
  69
+
  70
+.. code:: python
  71
+
  72
+	>>> manager = Manager(("./manager/tests/testsManager/resources/components/core",))
  73
+	>>> manager.registerComponents()
  74
+	True
  75
+	>>> manager.listComponents()
  76
+	['core.testsComponentA', 'core.testsComponentB']
  77
+	>>> manager.instantiateComponents()
  78
+	True
  79
+	>>> manager.getInterface("core.testsComponentA")
  80
+	<testsComponentA.TestsComponentA object at 0x11dd990>
  81
+
  82
+**manager.componentsManager.Manager.getInterface(name)** method returns the interface of given Component, in the previous example it's the object declared in the description file by this statement: **Object = TestsComponentA**.
  83
+
  84
+Three base Components are provided by default:
  85
+
  86
+-  **manager.component.Component**
  87
+-  **manager.qobjectComponent.QObjectComponent**
  88
+-  **manager.qwidgetComponent.QWidgetComponent**
  89
+
  90
+When inheriting from those Components, one have to reimplement the following methods:
  91
+
  92
+-  **activate**
  93
+-  **deactivate**
  94
+-  **initialize** ( **initializeUi** for **manager.qwidgetComponent.QWidgetComponent** )
  95
+-  **uninitialize** ( **uninitializeUi** for **manager.qwidgetComponent.QWidgetComponent** )
  96
+
  97
+The following attributes have to be set in those methods so that associated signals are emitted:
  98
+
  99
+- **activated**
  100
+- **initialized** ( **initializedUi** for **manager.qwidgetComponent.QWidgetComponent** )
  101
+
  102
+Reference Component implementation example class:
  103
+
  104
+.. code:: python
  105
+
  106
+	class TestsComponentA(Component):
  107
+
  108
+		def __init__(self, name=None):
  109
+			Component.__init__(self, name=name)
  110
+			
  111
+			self.deactivatable = True
  112
+
  113
+		def activate(self):
  114
+			print("> Activating '{0}' Component.".format(self.__class__.__name__))
  115
+
  116
+			self.activated = True
  117
+			return True
  118
+
  119
+		def deactivate(self):
  120
+			print("> Deactivating '{0}' Component.".format(self.__class__.__name__))
  121
+
  122
+			self.activated = False
  123
+			return True
  124
+
  125
+		def initialize(self):
  126
+			print("> Initializing '{0}' Component.".format(self.__class__.__name__))
  127
+
  128
+			self.initialized = True
  129
+			return True
  130
+
  131
+		def uninitialize(self):
  132
+			print("> Uninitializing '{0}' Component.".format(self.__class__.__name__))
  133
+
  134
+			self.initialized = False
  135
+			return True
17 136
 
18 137
 About
19 138
 -----
20 139
 
21  
-| Manager by Thomas Mansencal Ð 2008 - 2012
22  
-| Copyright© 2008 - 2012 Ð Thomas Mansencal Ð `thomas.mansencal@gmail.com <mailto:thomas.mansencal@gmail.com>`_
  140
+| **Manager** by Thomas Mansencal – 2008 - 2012
  141
+| Copyright© 2008 - 2012 – Thomas Mansencal – `thomas.mansencal@gmail.com <mailto:thomas.mansencal@gmail.com>`_
23 142
 | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/
24 143
 | `http://www.thomasmansencal.com/ <http://www.thomasmansencal.com/>`_
188  docs/help/Manager_Manual.html
@@ -82,12 +82,15 @@
82 82
 						<a class="reference internal" href="#installation">Installation</a>
83 83
 					</li>
84 84
 					<li>
85  
-						<a class="reference internal" href="#changes">Changes</a>
  85
+						<a class="reference internal" href="#usage">Usage</a>
86 86
 					</li>
87 87
 					<li>
88 88
 						<a class="reference internal" href="#api">Api</a>
89 89
 					</li>
90 90
 					<li>
  91
+						<a class="reference internal" href="#changes">Changes</a>
  92
+					</li>
  93
+					<li>
91 94
 						<a class="reference internal" href="#about">About</a>
92 95
 					</li>
93 96
 				</ul><br />
@@ -98,41 +101,202 @@
98 101
 					<span class="target" id="introduction">Introduction</span>
99 102
 				</h1>
100 103
 				<p>
101  
-					Manager is the Components Manager package of <a class="reference external" href="https://github.com/KelSolaar/Umbra">Umbra</a>, <a class="reference external" href="https://github.com/KelSolaar/sIBL_GUI">sIBL_GUI</a> and <a class="reference external" href="https://github.com/KelSolaar/sIBL_Reporter">sIBL_Reporter</a>.
  104
+					<strong>Manager</strong> is the Components Manager package of <a class="reference external" href="https://github.com/KelSolaar/Umbra">Umbra</a>, <a class="reference external" href="https://github.com/KelSolaar/sIBL_GUI">sIBL_GUI</a> and <a class="reference external" href="https://github.com/KelSolaar/sIBL_Reporter">sIBL_Reporter</a>. Components are simple python packages extending capabilities of their host application.
102 105
 				</p><br />
103 106
 				<!-- .installation -->
104 107
 			</div>
105 108
 			<div class="section" id="id2">
106 109
 				<h1>
107 110
 					<span class="target" id="installation">Installation</span>
108  
-				</h1><br />
109  
-				<!-- .api -->
  111
+				</h1>
  112
+				<p>
  113
+					To install <strong>Manager</strong> from the <a class="reference external" href="http://pypi.python.org/pypi/Manager">Python Package Index</a> you can issue this command in a shell:
  114
+				</p>
  115
+				<pre class="literal-block">
  116
+pip install Manager
  117
+</pre>
  118
+				<p>
  119
+					or this alternative command:
  120
+				</p>
  121
+				<pre class="literal-block">
  122
+easy_install Manager
  123
+</pre>
  124
+				<p>
  125
+					Alternatively, if you want to directly install from <a class="reference external" href="http://github.com/KelSolaar/Manager">Github</a> source repository:
  126
+				</p>
  127
+				<pre class="literal-block">
  128
+git clone git://github.com/KelSolaar/Manager.git
  129
+python setup.py install
  130
+</pre><br />
  131
+				<!-- .usage -->
110 132
 			</div>
111 133
 			<div class="section" id="id3">
112 134
 				<h1>
113  
-					<span class="target" id="api">Api</span>
  135
+					<span class="target" id="usage">Usage</span>
114 136
 				</h1>
115 137
 				<p>
116  
-					<em>Manager</em> Api documentation is available here: <a class="reference external" href="index.html">Manager - Api</a>
117  
-				</p><br />
118  
-				<!-- .changes -->
  138
+					Please refer to <a class="reference external" href="http://thomasmansencal.com/Sharing/Manager/Support/Documentation/Api/index.html">Manager - Api</a> for precise usage examples.
  139
+				</p>
  140
+				<p>
  141
+					A Component package contains at least a resource <strong>.rc</strong> description file and a main module:
  142
+				</p>
  143
+				<pre class="literal-block">
  144
+testsComponentA
  145
+├── __init__.py
  146
+├── testsComponentA.py
  147
+└── testsComponentA.rc
  148
+</pre>
  149
+				<p>
  150
+					The description file is a configuration style file with a structure similar to what you would find on Microsoft Windows INI files:
  151
+				</p>
  152
+				<pre class="literal-block">
  153
+[Component]
  154
+Name = core.testsComponentA
  155
+Title = Tests Component A
  156
+Module = testsComponentA
  157
+Object = TestsComponentA
  158
+Rank = 10
  159
+Version = 1.0
  160
+
  161
+[Informations]
  162
+Author = Thomas Mansencal
  163
+Email = thomas.mansencal&#64;gmail.com
  164
+Url = http://www.hdrlabs.com/
  165
+Description = Core tests Component A.
  166
+</pre>
  167
+				<p>
  168
+					Given the following directories structure:
  169
+				</p>
  170
+				<pre class="literal-block">
  171
+core
  172
+├── __init__.py
  173
+├── testsComponentA
  174
+│&nbsp;&nbsp; ├── __init__.py
  175
+│&nbsp;&nbsp; ├── testsComponentA.py
  176
+│&nbsp;&nbsp; └── testsComponentA.rc
  177
+└── testsComponentB
  178
+		├── __init__.py
  179
+		├── testsComponentB.py
  180
+		└── testsComponentB.rc
  181
+</pre>
  182
+				<p>
  183
+					Instantiating the Components Manager is done the following way:
  184
+				</p>
  185
+				<pre class="code python literal-block">
  186
+<span class="o">&gt;&gt;&gt;</span> <span class="n">manager</span> <span class="o">=</span> <span class="n">Manager</span><span class="p">((</span><span class="s">&quot;./manager/tests/testsManager/resources/components/core&quot;</span><span class="p">,))</span>
  187
+<span class="o">&gt;&gt;&gt;</span> <span class="n">manager</span><span class="o">.</span><span class="n">registerComponents</span><span class="p">()</span>
  188
+<span class="bp">True</span>
  189
+<span class="o">&gt;&gt;&gt;</span> <span class="n">manager</span><span class="o">.</span><span class="n">listComponents</span><span class="p">()</span>
  190
+<span class="p">[</span><span class="s">'core.testsComponentA'</span><span class="p">,</span> <span class="s">'core.testsComponentB'</span><span class="p">]</span>
  191
+<span class="o">&gt;&gt;&gt;</span> <span class="n">manager</span><span class="o">.</span><span class="n">instantiateComponents</span><span class="p">()</span>
  192
+<span class="bp">True</span>
  193
+<span class="o">&gt;&gt;&gt;</span> <span class="n">manager</span><span class="o">.</span><span class="n">getInterface</span><span class="p">(</span><span class="s">&quot;core.testsComponentA&quot;</span><span class="p">)</span>
  194
+<span class="o">&lt;</span><span class="n">testsComponentA</span><span class="o">.</span><span class="n">TestsComponentA</span> <span class="nb">object</span> <span class="n">at</span> <span class="mh">0x11dd990</span><span class="o">&gt;</span>
  195
+</pre>
  196
+				<p>
  197
+					<strong>manager.componentsManager.Manager.getInterface(name)</strong> method returns the interface of given Component, in the previous example it's the object declared in the description file by this statement: <strong>Object = TestsComponentA</strong>.
  198
+				</p>
  199
+				<p>
  200
+					Three base Components are provided by default:
  201
+				</p>
  202
+				<ul class="simple">
  203
+					<li>
  204
+						<strong>manager.component.Component</strong>
  205
+					</li>
  206
+					<li>
  207
+						<strong>manager.qobjectComponent.QObjectComponent</strong>
  208
+					</li>
  209
+					<li>
  210
+						<strong>manager.qwidgetComponent.QWidgetComponent</strong>
  211
+					</li>
  212
+				</ul>
  213
+				<p>
  214
+					When inheriting from those Components, one have to reimplement the following methods:
  215
+				</p>
  216
+				<ul class="simple">
  217
+					<li>
  218
+						<strong>activate</strong>
  219
+					</li>
  220
+					<li>
  221
+						<strong>deactivate</strong>
  222
+					</li>
  223
+					<li>
  224
+						<strong>initialize</strong> ( <strong>initializeUi</strong> for <strong>manager.qwidgetComponent.QWidgetComponent</strong> )
  225
+					</li>
  226
+					<li>
  227
+						<strong>uninitialize</strong> ( <strong>uninitializeUi</strong> for <strong>manager.qwidgetComponent.QWidgetComponent</strong> )
  228
+					</li>
  229
+				</ul>
  230
+				<p>
  231
+					The following attributes have to be set in those methods so that associated signals are emitted:
  232
+				</p>
  233
+				<ul class="simple">
  234
+					<li>
  235
+						<strong>activated</strong>
  236
+					</li>
  237
+					<li>
  238
+						<strong>initialized</strong> ( <strong>initializedUi</strong> for <strong>manager.qwidgetComponent.QWidgetComponent</strong> )
  239
+					</li>
  240
+				</ul>
  241
+				<p>
  242
+					Reference Component implementation example class:
  243
+				</p>
  244
+				<pre class="code python literal-block">
  245
+<span class="k">class</span> <span class="nc">TestsComponentA</span><span class="p">(</span><span class="n">Component</span><span class="p">):</span>
  246
+
  247
+		<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
  248
+				<span class="n">Component</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
  249
+
  250
+				<span class="bp">self</span><span class="o">.</span><span class="n">deactivatable</span> <span class="o">=</span> <span class="bp">True</span>
  251
+
  252
+		<span class="k">def</span> <span class="nf">activate</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  253
+				<span class="k">print</span><span class="p">(</span><span class="s">&quot;&gt; Activating '{0}' Component.&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">))</span>
  254
+
  255
+				<span class="bp">self</span><span class="o">.</span><span class="n">activated</span> <span class="o">=</span> <span class="bp">True</span>
  256
+				<span class="k">return</span> <span class="bp">True</span>
  257
+
  258
+		<span class="k">def</span> <span class="nf">deactivate</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  259
+				<span class="k">print</span><span class="p">(</span><span class="s">&quot;&gt; Deactivating '{0}' Component.&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">))</span>
  260
+
  261
+				<span class="bp">self</span><span class="o">.</span><span class="n">activated</span> <span class="o">=</span> <span class="bp">False</span>
  262
+				<span class="k">return</span> <span class="bp">True</span>
  263
+
  264
+		<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  265
+				<span class="k">print</span><span class="p">(</span><span class="s">&quot;&gt; Initializing '{0}' Component.&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">))</span>
  266
+
  267
+				<span class="bp">self</span><span class="o">.</span><span class="n">initialized</span> <span class="o">=</span> <span class="bp">True</span>
  268
+				<span class="k">return</span> <span class="bp">True</span>
  269
+
  270
+		<span class="k">def</span> <span class="nf">uninitialize</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  271
+				<span class="k">print</span><span class="p">(</span><span class="s">&quot;&gt; Uninitializing '{0}' Component.&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">))</span>
  272
+
  273
+				<span class="bp">self</span><span class="o">.</span><span class="n">initialized</span> <span class="o">=</span> <span class="bp">False</span>
  274
+				<span class="k">return</span> <span class="bp">True</span>
  275
+</pre><br />
  276
+				<!-- .api -->
119 277
 			</div>
120 278
 			<div class="section" id="id4">
121 279
 				<h1>
122  
-					<span class="target" id="changes">Changes</span>
  280
+					<span class="target" id="api">Api</span>
123 281
 				</h1>
124 282
 				<p>
125  
-					<strong>Manager - Changes</strong>: Change_Log.html
  283
+					<strong>Manager</strong> Api documentation is available here: <a class="reference external" href="http://thomasmansencal.com/Sharing/Manager/Support/Documentation/Api/index.html">Manager - Api</a>
126 284
 				</p><br />
  285
+				<!-- .changes -->
  286
+			</div>
  287
+			<div class="section" id="id6">
  288
+				<h1>
  289
+					<span class="target" id="changes">Changes</span>
  290
+				</h1><br />
127 291
 				<!-- .about -->
128 292
 			</div>
129  
-			<div class="section" id="id5">
  293
+			<div class="section" id="id7">
130 294
 				<h1>
131 295
 					<span class="target" id="about">About</span>
132 296
 				</h1>
133 297
 				<div class="line-block">
134 298
 					<div class="line">
135  
-						<em>Manager</em> by Thomas Mansencal - 2008 - 2012
  299
+						<strong>Manager</strong> by Thomas Mansencal - 2008 - 2012
136 300
 					</div>
137 301
 					<div class="line">
138 302
 						Copyright© 2008 - 2012 - Thomas Mansencal - <a class="reference external" href="mailto:thomas.mansencal&#64;gmail.com">thomas.mansencal&#64;gmail.com</a>
138  docs/help/Manager_Manual.rst
Source Rendered
@@ -12,6 +12,7 @@ Table Of Content
12 12
 
13 13
 -  `Introduction`_
14 14
 -  `Installation`_
  15
+-  `Usage`_
15 16
 -  `Api`_
16 17
 -  `Changes`_
17 18
 -  `About`_
@@ -25,7 +26,7 @@ Table Of Content
25 26
 _`Introduction`
26 27
 ===============
27 28
 
28  
-Manager is the Components Manager package of `Umbra <https://github.com/KelSolaar/Umbra>`_, `sIBL_GUI <https://github.com/KelSolaar/sIBL_GUI>`_ and `sIBL_Reporter <https://github.com/KelSolaar/sIBL_Reporter>`_.
  29
+**Manager** is the Components Manager package of `Umbra <https://github.com/KelSolaar/Umbra>`_, `sIBL_GUI <https://github.com/KelSolaar/sIBL_GUI>`_ and `sIBL_Reporter <https://github.com/KelSolaar/sIBL_Reporter>`_. Components are simple python packages extending capabilities of their host application.
29 30
 
30 31
 .. raw:: html
31 32
 
@@ -36,6 +37,135 @@ Manager is the Components Manager package of `Umbra <https://github.com/KelSolaa
36 37
 _`Installation`
37 38
 ===============
38 39
 
  40
+To install **Manager** from the `Python Package Index <http://pypi.python.org/pypi/Manager>`_ you can issue this command in a shell::
  41
+
  42
+	pip install Manager
  43
+
  44
+or this alternative command::
  45
+
  46
+	easy_install Manager
  47
+
  48
+Alternatively, if you want to directly install from `Github <http://github.com/KelSolaar/Manager>`_ source repository::
  49
+
  50
+	git clone git://github.com/KelSolaar/Manager.git
  51
+	python setup.py install
  52
+
  53
+.. raw:: html
  54
+
  55
+    <br/>
  56
+
  57
+.. .usage
  58
+
  59
+_`Usage`
  60
+========
  61
+
  62
+Please refer to `Manager - Api <http://thomasmansencal.com/Sharing/Manager/Support/Documentation/Api/index.html>`_ for precise usage examples.
  63
+
  64
+A Component package contains at least a resource **.rc** description file and a main module::
  65
+
  66
+	testsComponentA
  67
+	├── __init__.py
  68
+	├── testsComponentA.py
  69
+	└── testsComponentA.rc
  70
+
  71
+The description file is a configuration style file with a structure similar to what you would find on Microsoft Windows INI files::
  72
+
  73
+	[Component]
  74
+	Name = core.testsComponentA
  75
+	Title = Tests Component A
  76
+	Module = testsComponentA
  77
+	Object = TestsComponentA
  78
+	Rank = 10
  79
+	Version = 1.0
  80
+
  81
+	[Informations]
  82
+	Author = Thomas Mansencal
  83
+	Email = thomas.mansencal@gmail.com
  84
+	Url = http://www.hdrlabs.com/
  85
+	Description = Core tests Component A.
  86
+
  87
+Given the following directories structure::
  88
+
  89
+	core
  90
+	├── __init__.py
  91
+	├── testsComponentA
  92
+	│   ├── __init__.py
  93
+	│   ├── testsComponentA.py
  94
+	│   └── testsComponentA.rc
  95
+	└── testsComponentB
  96
+		├── __init__.py
  97
+		├── testsComponentB.py
  98
+		└── testsComponentB.rc
  99
+
  100
+Instantiating the Components Manager is done the following way:
  101
+
  102
+.. code:: python
  103
+
  104
+	>>> manager = Manager(("./manager/tests/testsManager/resources/components/core",))
  105
+	>>> manager.registerComponents()
  106
+	True
  107
+	>>> manager.listComponents()
  108
+	['core.testsComponentA', 'core.testsComponentB']
  109
+	>>> manager.instantiateComponents()
  110
+	True
  111
+	>>> manager.getInterface("core.testsComponentA")
  112
+	<testsComponentA.TestsComponentA object at 0x11dd990>
  113
+
  114
+**manager.componentsManager.Manager.getInterface(name)** method returns the interface of given Component, in the previous example it's the object declared in the description file by this statement: **Object = TestsComponentA**.
  115
+
  116
+Three base Components are provided by default:
  117
+
  118
+-  **manager.component.Component**
  119
+-  **manager.qobjectComponent.QObjectComponent**
  120
+-  **manager.qwidgetComponent.QWidgetComponent**
  121
+
  122
+When inheriting from those Components, one have to reimplement the following methods:
  123
+
  124
+-  **activate**
  125
+-  **deactivate**
  126
+-  **initialize** ( **initializeUi** for **manager.qwidgetComponent.QWidgetComponent** )
  127
+-  **uninitialize** ( **uninitializeUi** for **manager.qwidgetComponent.QWidgetComponent** )
  128
+
  129
+The following attributes have to be set in those methods so that associated signals are emitted:
  130
+
  131
+- **activated**
  132
+- **initialized** ( **initializedUi** for **manager.qwidgetComponent.QWidgetComponent** )
  133
+
  134
+Reference Component implementation example class:
  135
+
  136
+.. code:: python
  137
+
  138
+	class TestsComponentA(Component):
  139
+
  140
+		def __init__(self, name=None):
  141
+			Component.__init__(self, name=name)
  142
+			
  143
+			self.deactivatable = True
  144
+
  145
+		def activate(self):
  146
+			print("> Activating '{0}' Component.".format(self.__class__.__name__))
  147
+
  148
+			self.activated = True
  149
+			return True
  150
+
  151
+		def deactivate(self):
  152
+			print("> Deactivating '{0}' Component.".format(self.__class__.__name__))
  153
+
  154
+			self.activated = False
  155
+			return True
  156
+
  157
+		def initialize(self):
  158
+			print("> Initializing '{0}' Component.".format(self.__class__.__name__))
  159
+
  160
+			self.initialized = True
  161
+			return True
  162
+
  163
+		def uninitialize(self):
  164
+			print("> Uninitializing '{0}' Component.".format(self.__class__.__name__))
  165
+
  166
+			self.initialized = False
  167
+			return True
  168
+
39 169
 .. raw:: html
40 170
 
41 171
     <br/>
@@ -45,7 +175,7 @@ _`Installation`
45 175
 _`Api`
46 176
 ======
47 177
 
48  
-*Manager* Api documentation is available here: `Manager - Api <index.html>`_
  178
+**Manager** Api documentation is available here: `Manager - Api <http://thomasmansencal.com/Sharing/Manager/Support/Documentation/Api/index.html>`_
49 179
 
50 180
 .. raw:: html
51 181
 
@@ -56,8 +186,6 @@ _`Api`
56 186
 _`Changes`
57 187
 ==========
58 188
 
59  
-**Manager - Changes**: Changes.html
60  
-
61 189
 .. raw:: html
62 190
 
63 191
     <br/>
@@ -67,7 +195,7 @@ _`Changes`
67 195
 _`About`
68 196
 ========
69 197
 
70  
-| *Manager* by Thomas Mansencal - 2008 - 2012
  198
+| **Manager** by Thomas Mansencal - 2008 - 2012
71 199
 | Copyright© 2008 - 2012 - Thomas Mansencal - `thomas.mansencal@gmail.com <mailto:thomas.mansencal@gmail.com>`_
72 200
 | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/
73 201
 | http://www.thomasmansencal.com/
3  docs/sphinx/source/index.rst
Source Rendered
@@ -9,8 +9,9 @@ Contents:
9 9
 
10 10
  Introduction <resources/pages/introduction>
11 11
  Installation <resources/pages/installation>
12  
- Changes <resources/pages/changes>
  12
+ Usage <resources/pages/usage>
13 13
  Api <resources/pages/api>
  14
+ Changes <resources/pages/changes>
14 15
  About <resources/pages/about>
15 16
 
16 17
 Search:
10  docs/sphinx/source/resources/pages/about.rst
Source Rendered
... ...
@@ -1,7 +1,7 @@
1  
-_`About`
2  
-========
  1
+About
  2
+-----
3 3
 
4  
-| *Manager* by Thomas Mansencal - 2008 - 2012
5  
-| Copyright© 2008 - 2012 - Thomas Mansencal - `thomas.mansencal@gmail.com <mailto:thomas.mansencal@gmail.com>`_
  4
+| **Manager** by Thomas Mansencal – 2008 - 2012
  5
+| Copyright© 2008 - 2012 – Thomas Mansencal – `thomas.mansencal@gmail.com <mailto:thomas.mansencal@gmail.com>`_
6 6
 | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/
7  
-| http://www.thomasmansencal.com/
  7
+| `http://www.thomasmansencal.com/ <http://www.thomasmansencal.com/>`_
51  docs/sphinx/source/resources/pages/api.rst
Source Rendered
@@ -6,60 +6,9 @@ Modules Summary:
6 6
 .. toctree::
7 7
    :maxdepth: 1
8 8
 
9  
-   foundations.cache <api/foundations.cache>
10  
-   foundations.common <api/foundations.common>
11  
-   foundations.core <api/foundations.core>
12  
-   foundations.dataStructures <api/foundations.dataStructures>
13  
-   foundations.environment <api/foundations.environment>
14  
-   foundations.exceptions <api/foundations.exceptions>
15  
-   foundations.globals.constants <api/foundations.globals.constants>
16  
-   foundations.io <api/foundations.io>
17  
-   foundations.library <api/foundations.library>
18  
-   foundations.namespace <api/foundations.namespace>
19  
-   foundations.nodes <api/foundations.nodes>
20  
-   foundations.parsers <api/foundations.parsers>
21  
-   foundations.pkzip <api/foundations.pkzip>
22  
-   foundations.rotatingBackup <api/foundations.rotatingBackup>
23  
-   foundations.streamObject <api/foundations.streamObject>
24  
-   foundations.strings <api/foundations.strings>
25  
-   foundations.tcpServer <api/foundations.tcpServer>
26  
-   foundations.ui.common <api/foundations.ui.common>
27  
-   foundations.walkers <api/foundations.walkers>
28 9
    manager.component <api/manager.component>
29 10
    manager.componentsManager <api/manager.componentsManager>
30 11
    manager.exceptions <api/manager.exceptions>
31 12
    manager.globals.constants <api/manager.globals.constants>
32 13
    manager.qobjectComponent <api/manager.qobjectComponent>
33 14
    manager.qwidgetComponent <api/manager.qwidgetComponent>
34  
-   foundations.tests.tests <api/foundations.tests.tests>
35  
-   foundations.tests.testsFoundations.testsCache <api/foundations.tests.testsFoundations.testsCache>
36  
-   foundations.tests.testsFoundations.testsCommon <api/foundations.tests.testsFoundations.testsCommon>
37  
-   foundations.tests.testsFoundations.testsCore <api/foundations.tests.testsFoundations.testsCore>
38  
-   foundations.tests.testsFoundations.testsDataStructures <api/foundations.tests.testsFoundations.testsDataStructures>
39  
-   foundations.tests.testsFoundations.testsEnvironment <api/foundations.tests.testsFoundations.testsEnvironment>
40  
-   foundations.tests.testsFoundations.testsExceptions <api/foundations.tests.testsFoundations.testsExceptions>
41  
-   foundations.tests.testsFoundations.testsGlobals.testsConstants <api/foundations.tests.testsFoundations.testsGlobals.testsConstants>
42  
-   foundations.tests.testsFoundations.testsIo <api/foundations.tests.testsFoundations.testsIo>
43  
-   foundations.tests.testsFoundations.testsLibrary <api/foundations.tests.testsFoundations.testsLibrary>
44  
-   foundations.tests.testsFoundations.testsNamespace <api/foundations.tests.testsFoundations.testsNamespace>
45  
-   foundations.tests.testsFoundations.testsNodes <api/foundations.tests.testsFoundations.testsNodes>
46  
-   foundations.tests.testsFoundations.testsParsers <api/foundations.tests.testsFoundations.testsParsers>
47  
-   foundations.tests.testsFoundations.testsPkzip <api/foundations.tests.testsFoundations.testsPkzip>
48  
-   foundations.tests.testsFoundations.testsRotatingBackup <api/foundations.tests.testsFoundations.testsRotatingBackup>
49  
-   foundations.tests.testsFoundations.testsStreamObject <api/foundations.tests.testsFoundations.testsStreamObject>
50  
-   foundations.tests.testsFoundations.testsStrings <api/foundations.tests.testsFoundations.testsStrings>
51  
-   foundations.tests.testsFoundations.testsTcpServer <api/foundations.tests.testsFoundations.testsTcpServer>
52  
-   foundations.tests.testsFoundations.testsUi.testsCommon <api/foundations.tests.testsFoundations.testsUi.testsCommon>
53  
-   foundations.tests.testsFoundations.testsWalkers <api/foundations.tests.testsFoundations.testsWalkers>
54  
-   foundations.tests.utilities <api/foundations.tests.utilities>
55  
-   manager.tests.tests <api/manager.tests.tests>
56  
-   manager.tests.testsManager.resources.components.addons.testsComponentC.testsComponentC <api/manager.tests.testsManager.resources.components.addons.testsComponentC.testsComponentC>
57  
-   manager.tests.testsManager.resources.components.core.testsComponentA.testsComponentA <api/manager.tests.testsManager.resources.components.core.testsComponentA.testsComponentA>
58  
-   manager.tests.testsManager.resources.components.core.testsComponentB.testsComponentB <api/manager.tests.testsManager.resources.components.core.testsComponentB.testsComponentB>
59  
-   manager.tests.testsManager.testsComponent <api/manager.tests.testsManager.testsComponent>
60  
-   manager.tests.testsManager.testsComponentsManager <api/manager.tests.testsManager.testsComponentsManager>
61  
-   manager.tests.testsManager.testsExceptions <api/manager.tests.testsManager.testsExceptions>
62  
-   manager.tests.testsManager.testsGlobals.testsConstants <api/manager.tests.testsManager.testsGlobals.testsConstants>
63  
-   manager.tests.testsManager.testsQObjectComponent <api/manager.tests.testsManager.testsQObjectComponent>
64  
-   manager.tests.testsManager.testsQWidgetComponent <api/manager.tests.testsManager.testsQWidgetComponent>
65  
-   manager.tests.utilities <api/manager.tests.utilities>
17  docs/sphinx/source/resources/pages/api/foundations.cache.rst
Source Rendered
... ...
@@ -1,17 +0,0 @@
1  
-_`foundations.cache`
2  
-====================
3  
-
4  
-.. automodule:: foundations.cache
5  
-
6  
-Module Attributes
7  
------------------
8  
-
9  
-.. attribute:: foundations.cache.LOGGER
10  
-
11  
-Classes
12  
--------
13  
-
14  
-.. autoclass:: Cache
15  
-	:show-inheritance:
16  
-	:members:
17  
-
25  docs/sphinx/source/resources/pages/api/foundations.common.rst
Source Rendered
... ...
@@ -1,25 +0,0 @@
1  
-_`foundations.common`
2  
-=====================
3  
-
4  
-.. automodule:: foundations.common
5  
-
6  
-Module Attributes
7  
------------------
8  
-
9  
-.. attribute:: foundations.common.LOGGER
10  
-
11  
-Functions
12  
----------
13  
-
14  
-.. autofunction:: uniqify
15  
-
16  
-.. autofunction:: orderedUniqify
17  
-
18  
-.. autofunction:: pathExists
19  
-
20  
-.. autofunction:: getFirstItem
21  
-
22  
-.. autofunction:: isBinaryFile
23  
-
24  
-.. autofunction:: repeat
25  
-
60  docs/sphinx/source/resources/pages/api/foundations.core.rst
Source Rendered
... ...
@@ -1,60 +0,0 @@
1  
-_`foundations.core`
2  
-===================
3  
-
4  
-.. automodule:: foundations.core
5  
-
6  
-Module Attributes
7  
------------------
8  
-
9  
-.. attribute:: foundations.core.THREADS_IDENTIFIERS
10  
-
11  
-.. attribute:: foundations.core.LOGGER
12  
-
13  
-.. attribute:: foundations.core.LOGGING_DEFAULT_FORMATTER
14  
-
15  
-.. attribute:: foundations.core.LOGGING_EXTENDED_FORMATTER
16  
-
17  
-.. attribute:: foundations.core.LOGGING_STANDARD_FORMATTER
18  
-
19  
-.. attribute:: foundations.core.IGNORED_CODE_LAYERS
20  
-
21  
-.. attribute:: foundations.core.UNDEFINED_CODE_LAYER
22  
-
23  
-.. attribute:: foundations.core.UNDEFINED_MODULE
24  
-
25  
-.. attribute:: foundations.core.UNDEFINED_OBJECT
26  
-
27  
-Functions
28  
----------
29  
-
30  
-.. autofunction:: setVerbosityLevel
31  
-
32  
-.. autofunction:: getFrame
33  
-
34  
-.. autofunction:: getCodeLayerName
35  
-
36  
-.. autofunction:: getModule
37  
-
38  
-.. autofunction:: getTraceName
39  
-
40  
-.. autofunction:: extractStack
41  
-
42  
-.. autofunction:: executionTrace
43  
-
44  
-.. autofunction:: executionTime
45  
-
46  
-.. autofunction:: memoize
47  
-
48  
-.. autofunction:: removeLoggingHandler
49  
-
50  
-.. autofunction:: exit
51  
-
52  
-.. autofunction:: wait
53  
-
54  
-Classes
55  
--------
56  
-
57  
-.. autoclass:: StandardMessageHook
58  
-	:show-inheritance:
59  
-	:members:
60  
-
29  docs/sphinx/source/resources/pages/api/foundations.dataStructures.rst
Source Rendered
... ...
@@ -1,29 +0,0 @@
1  
-_`foundations.dataStructures`
2  
-=============================
3  
-
4  
-.. automodule:: foundations.dataStructures
5  
-
6  
-Module Attributes
7  
------------------
8  
-
9  
-.. attribute:: foundations.dataStructures.LOGGER
10  
-
11  
-Classes
12  
--------
13  
-
14  
-.. autoclass:: NestedAttribute
15  
-	:show-inheritance:
16  
-	:members:
17  
-
18  
-.. autoclass:: Structure
19  
-	:show-inheritance:
20  
-	:members:
21  
-
22  
-.. autoclass:: OrderedStructure
23  
-	:show-inheritance:
24  
-	:members:
25  
-
26  
-.. autoclass:: Lookup
27  
-	:show-inheritance:
28  
-	:members:
29  
-
24  docs/sphinx/source/resources/pages/api/foundations.environment.rst
Source Rendered
... ...
@@ -1,24 +0,0 @@
1  
-_`foundations.environment`
2  
-==========================
3  
-
4  
-.. automodule:: foundations.environment
5  
-
6  
-Module Attributes
7  
------------------
8  
-
9  
-.. attribute:: foundations.environment.LOGGER
10  
-
11  
-Functions
12  
----------
13  
-
14  
-.. autofunction:: getSystemApplicationDataDirectory
15  
-
16  
-.. autofunction:: getUserApplicationDataDirectory
17  
-
18  
-Classes
19  
--------
20  
-
21  
-.. autoclass:: Environment
22  
-	:show-inheritance:
23  
-	:members:
24  
-
116  docs/sphinx/source/resources/pages/api/foundations.exceptions.rst
Source Rendered
... ...
@@ -1,116 +0,0 @@
1  
-_`foundations.exceptions`
2  
-=========================
3  
-
4  
-.. automodule:: foundations.exceptions
5  
-
6  
-Module Attributes
7  
------------------
8  
-
9  
-.. attribute:: foundations.exceptions.LOGGER
10  
-
11  
-Functions
12  
----------
13  
-
14  
-.. autofunction:: exceptionsHandler
15  
-
16  
-.. autofunction:: defaultExceptionsHandler
17  
-
18  
-Classes
19  
--------
20  
-
21  
-.. autoclass:: AbstractError
22  
-	:show-inheritance:
23  
-	:members:
24  
-
25  
-.. autoclass:: BreakIteration
26  
-	:show-inheritance:
27  
-	:members:
28  
-
29  
-.. autoclass:: AbstractParsingError
30  
-	:show-inheritance:
31  
-	:members:
32  
-
33  
-.. autoclass:: FileStructureParsingError
34  
-	:show-inheritance:
35  
-	:members:
36  
-
37  
-.. autoclass:: AttributeStructureParsingError
38  
-	:show-inheritance:
39  
-	:members:
40  
-
41  
-.. autoclass:: AbstractOsError
42  
-	:show-inheritance:
43  
-	:members:
44  
-
45  
-.. autoclass:: PathExistsError
46  
-	:show-inheritance:
47  
-	:members:
48  
-
49  
-.. autoclass:: DirectoryExistsError
50  
-	:show-inheritance:
51  
-	:members:
52  
-
53  
-.. autoclass:: FileExistsError
54  
-	:show-inheritance:
55  
-	:members:
56  
-
57  
-.. autoclass:: AbstractObjectError
58  
-	:show-inheritance:
59  
-	:members:
60  
-
61  
-.. autoclass:: ObjectTypeError
62  
-	:show-inheritance:
63  
-	:members:
64  
-
65  
-.. autoclass:: ObjectExistsError
66  
-	:show-inheritance:
67  
-	:members:
68  
-
69  
-.. autoclass:: AbstractUserError
70  
-	:show-inheritance:
71  
-	:members:
72  
-
73  
-.. autoclass:: ProgrammingError
74  
-	:show-inheritance:
75  
-	:members:
76  
-
77  
-.. autoclass:: UserError
78  
-	:show-inheritance:
79  
-	:members:
80  
-
81  
-.. autoclass:: AbstractNodeError
82  
-	:show-inheritance:
83  
-	:members:
84  
-
85  
-.. autoclass:: NodeAttributeTypeError
86  
-	:show-inheritance:
87  
-	:members:
88  
-
89  
-.. autoclass:: NodeAttributeExistsError
90  
-	:show-inheritance:
91  
-	:members:
92  
-
93  
-.. autoclass:: AbstractLibraryError
94  
-	:show-inheritance:
95  
-	:members:
96  
-
97  
-.. autoclass:: LibraryInstantiationError
98  
-	:show-inheritance:
99  
-	:members:
100  
-
101  
-.. autoclass:: LibraryInitializationError
102  
-	:show-inheritance:
103  
-	:members:
104  
-
105  
-.. autoclass:: LibraryExecutionError
106  
-	:show-inheritance:
107  
-	:members:
108  
-
109  
-.. autoclass:: AbstractServerError
110  
-	:show-inheritance:
111  
-	:members:
112  
-
113  
-.. autoclass:: ServerOperationError
114  
-	:show-inheritance:
115  
-	:members:
116  
-
12  docs/sphinx/source/resources/pages/api/foundations.globals.constants.rst
Source Rendered
... ...
@@ -1,12 +0,0 @@
1  
-_`foundations.globals.constants`
2  
-================================
3  
-
4  
-.. automodule:: foundations.globals.constants
5  
-
6  
-Classes
7  
--------
8  
-
9  
-.. autoclass:: Constants
10  
-	:show-inheritance:
11  
-	:members:
12  
-
26  docs/sphinx/source/resources/pages/api/foundations.io.rst
Source Rendered
... ...
@@ -1,26 +0,0 @@
1  
-_`foundations.io`
2  
-=================
3  
-
4  
-.. automodule:: foundations.io
5  
-
6  
-Module Attributes
7  
------------------
8  
-
9  
-.. attribute:: foundations.io.LOGGER
10  
-
11  
-Functions
12  
----------
13  
-
14  
-.. autofunction:: setDirectory
15  
-
16  
-.. autofunction:: copy
17  
-
18  
-.. autofunction:: remove
19  
-
20  
-Classes
21  
--------
22  
-
23  
-.. autoclass:: File
24  
-	:show-inheritance:
25  
-	:members:
26  
-
21  docs/sphinx/source/resources/pages/api/foundations.library.rst
Source Rendered
... ...
@@ -1,21 +0,0 @@
1  
-_`foundations.library`
2  
-======================
3  
-
4  
-.. automodule:: foundations.library
5  
-
6  
-Module Attributes
7  
------------------
8  
-
9  
-.. attribute:: foundations.library.LOGGER
10  
-
11  
-Classes
12  
--------
13  
-
14  
-.. autoclass:: LibraryHook
15  
-	:show-inheritance:
16  
-	:members:
17  
-
18  
-.. autoclass:: Library
19  
-	:show-inheritance:
20  
-	:members:
21  
-
21  docs/sphinx/source/resources/pages/api/foundations.namespace.rst
Source Rendered
... ...
@@ -1,21 +0,0 @@
1  
-_`foundations.namespace`
2  
-========================
3  
-
4  
-.. automodule:: foundations.namespace
5  
-
6  
-Module Attributes
7  
------------------
8  
-
9  
-.. attribute:: foundations.namespace.LOGGER
10  
-
11  
-.. attribute:: foundations.namespace.NAMESPACE_SPLITTER
12  
-
13  
-Functions
14  
----------
15  
-