Skip to content

Commit

Permalink
extend documentation; fixes #5
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Jun 22, 2015
1 parent 3ca8d37 commit 77a8130
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
33 changes: 33 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 15 additions & 0 deletions doc/testing.rst
Original file line number Diff line number Diff line change
@@ -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>`__.

0 comments on commit 77a8130

Please sign in to comment.