adapt doc directory tree structure
This commit is contained in:
11
doc/contributors/documentation.rst
Normal file
11
doc/contributors/documentation.rst
Normal file
@ -0,0 +1,11 @@
|
||||
|
||||
|
||||
Documentation
|
||||
=============
|
||||
|
||||
This documentation is refreshed upon each push to the central repository.
|
||||
|
||||
The module reference documentation is generated from the module sources using
|
||||
``#.rst:`` tags (compare for instance
|
||||
http://autocmake.readthedocs.org/en/latest/module-reference.html#cc-cmake with
|
||||
https://github.com/scisoft/autocmake/blob/master/modules/cc.cmake).
|
10
doc/contributors/guidelines.rst
Normal file
10
doc/contributors/guidelines.rst
Normal file
@ -0,0 +1,10 @@
|
||||
|
||||
|
||||
Contributing guidelines
|
||||
=======================
|
||||
|
||||
Please follow the excellent guide: http://www.contribution-guide.org.
|
||||
|
||||
We do not require any formal copyright assignment or contributor license
|
||||
agreement. Any contributions intentionally sent upstream are presumed to be
|
||||
offered under terms of the OSI-approved BSD 3-clause License.
|
15
doc/contributors/testing.rst
Normal file
15
doc/contributors/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>`__.
|
Reference in New Issue
Block a user