X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=t%2Fdoc%2Fconfig.rst;h=fe4066203a8e4ebefd45470e420c77089697cc52;hb=204f84eafd2659dd82b06feb7d182d4a15a44237;hp=57d58c1d226ff96c066dd458baef56f944699e14;hpb=b07a7c4bf08db2928e1845c4e60798f7c9ad8b65;p=moe.git diff --git a/t/doc/config.rst b/t/doc/config.rst index 57d58c1..fe40662 100644 --- a/t/doc/config.rst +++ b/t/doc/config.rst @@ -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