From 77a81300cd1b1e97576012ff10bed6fd4d58de68 Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Mon, 22 Jun 2015 15:06:14 +0200 Subject: [PATCH] extend documentation; fixes #5 --- doc/index.rst | 33 +++++++++++++++++++++++++++++++++ doc/testing.rst | 15 +++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 doc/testing.rst diff --git a/doc/index.rst b/doc/index.rst index a9ffd8e..f2e6c10 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,11 +3,44 @@ Autocmake ========= + +General +------- + .. toctree:: :maxdepth: 2 about.rst + + +For Developers who use Autocmake +-------------------------------- + +.. toctree:: + :maxdepth: 2 + new-project.rst customizing-modules.rst updating-modules.rst + + +For Users of projects that use Autocmake +---------------------------------------- + + +For Developers/contributors to Autocmake +---------------------------------------- + +.. toctree:: + :maxdepth: 2 + + testing.rst + + +Reference +--------- + +.. toctree:: + :maxdepth: 2 + module-reference.rst diff --git a/doc/testing.rst b/doc/testing.rst new file mode 100644 index 0000000..e66e3bc --- /dev/null +++ b/doc/testing.rst @@ -0,0 +1,15 @@ + + +Testing Autocmake +================= + +You will need to install `pytest `__. +Check also the `Travis build and test recipe `__ +for other requirements. + +Your contributions and changes should preserve the test set. You can run it locally with:: + + $ py.test test/test.py + +This test set is run upon each push to the central repository. +See also the `Travis build and test history `__.