]> mj.ucw.cz Git - moe.git/blobdiff - t/doc/config.rst
Update makefile
[moe.git] / t / doc / config.rst
index 57d58c1d226ff96c066dd458baef56f944699e14..fe4066203a8e4ebefd45470e420c77089697cc52 100644 (file)
@@ -1,34 +1,53 @@
+.. _config:
+
 Moe configuration
 =================
 
-The configuration consists of lazy definition-style configuration resolver and configuration parser.
 
-.. contents::
+.. contents:: 
+
+The configuration consists of lazy definition-style configuration resolver and configuration parser.
 
+The configuration variables form a dot-separated tree, but internally the list of variables is just 
+flat with full names.
 
-Config elements
-----------------
+Configuration tree
+++++++++++++++++++
 
 .. automodule:: moe.config
-       :members: ConfigError, UndefinedError, VariableNameError, VariableFixedError, CyclicConfigError, ConfigTree, ConfigElem, ConfigCondition
-       :undoc-members:
 
-       
-Internal classes
-++++++++++++++++
+  Exceptions
+  ----------
+
+  .. autoclass:: ConfigError
+  .. autoclass:: UndefinedError
+  .. autoclass:: VariableNameError
+  .. autoclass:: VariableFixedError
+  .. autoclass:: CyclicConfigError
+
+  Configuration tree
+  ------------------
+
+  .. autoclass:: ConfigTree
+    :members:
+
+  Main config elements
+  --------------------
 
-.. autoclass:: moe.config.Operation
-       :members:
-       :undoc-members:
-.. autoclass:: moe.config.ConfigVar
-       :members:
-       :undoc-members:
-.. autoclass:: moe.config.ConfigExpression
-       :members:
-       :undoc-members:
+  .. autoclass:: ConfigElem
+    :members:
+  .. autoclass:: ConfigCondition
+    :members:
+  .. autoclass:: ConfigVar
+    :members:
+  
+  Internal config elements
+  ------------------------
 
+  .. autoclass:: Operation
+  .. autoclass:: ConfigExpression
 
 Config parser
---------------
++++++++++++++
 
 .. automodule:: moe.config_parser