extend documentation; fixes #5
This commit is contained in:
parent
3ca8d37111
commit
77a81300cd
@ -3,11 +3,44 @@
|
|||||||
Autocmake
|
Autocmake
|
||||||
=========
|
=========
|
||||||
|
|
||||||
|
|
||||||
|
General
|
||||||
|
-------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
about.rst
|
about.rst
|
||||||
|
|
||||||
|
|
||||||
|
For Developers who use Autocmake
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
new-project.rst
|
new-project.rst
|
||||||
customizing-modules.rst
|
customizing-modules.rst
|
||||||
updating-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
|
module-reference.rst
|
||||||
|
15
doc/testing.rst
Normal file
15
doc/testing.rst
Normal 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>`__.
|
Loading…
x
Reference in New Issue
Block a user