CLIMATE-581 - Add API level docs for config writer to Sphinx build
Project: http://git-wip-us.apache.org/repos/asf/climate/repo Commit: http://git-wip-us.apache.org/repos/asf/climate/commit/acce351a Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/acce351a Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/acce351a Branch: refs/heads/master Commit: acce351a8abc11d1215e627e297da1fe16ef4703 Parents: 9167f1a Author: Michael Joyce <[email protected]> Authored: Wed Mar 25 11:36:12 2015 -0700 Committer: Michael Joyce <[email protected]> Committed: Wed Mar 25 11:36:12 2015 -0700 ---------------------------------------------------------------------- docs/source/config/config_overview.rst | 5 +++++ docs/source/config/config_writer.rst | 5 +++++ 2 files changed, 10 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/climate/blob/acce351a/docs/source/config/config_overview.rst ---------------------------------------------------------------------- diff --git a/docs/source/config/config_overview.rst b/docs/source/config/config_overview.rst index aa2953b..d3141f4 100644 --- a/docs/source/config/config_overview.rst +++ b/docs/source/config/config_overview.rst @@ -78,3 +78,8 @@ If you have tried the **simple_model_to_model_bias.py** example in the primary t .. note:: If you haven't run the previous example which downloads the necessary datasets this evaluation will fail. The necessary local files will not have been downloaded! + +Writing a Config File +--------------------- + +You can export an :class:`evaluation.Evaluation` object to a configuration file for easily repeatable evaluations. Checkout the documentation on the :doc:`configuration file writer API <config_writer>` for additional information. http://git-wip-us.apache.org/repos/asf/climate/blob/acce351a/docs/source/config/config_writer.rst ---------------------------------------------------------------------- diff --git a/docs/source/config/config_writer.rst b/docs/source/config/config_writer.rst new file mode 100644 index 0000000..eb9bb38 --- /dev/null +++ b/docs/source/config/config_writer.rst @@ -0,0 +1,5 @@ +Configuration File Writer API +============================= + +.. automodule:: configuration_writer + :members:
