extend documentation; fixes #5

This commit is contained in:
Radovan Bast 2015-06-22 15:06:14 +02:00
parent 3ca8d37111
commit 77a81300cd
2 changed files with 48 additions and 0 deletions

View File

@ -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

15
doc/testing.rst Normal file
View File

@ -0,0 +1,15 @@
Testing Autocmake
=================
You will need to install `pytest <http://pytest.org/>`__.
Check also the `Travis build and test recipe <https://github.com/scisoft/autocmake/blob/master/.travis.yml>`__
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 <https://travis-ci.org/scisoft/autocmake/builds>`__.