diff options
| author |   David Medina <davidmedina9@gmail.com> | 2012-04-28 23:36:00 +0200 |
|---|---|---|
| committer | David Medina <davidmedina9@gmail.com> | 2012-04-28 23:49:17 +0200 |
| commit | 8f1b051b465dca03e0232d48e50321e7689e63ce (patch) | |
| tree | ce5ab7a7749cde72d36485a46010082e75152ba3 | |
| parent | Merged pull request #7 from alejandrogomez (diff) | |
| download | python-github3-8f1b051b465dca03e0232d48e50321e7689e63ce.tar.xz python-github3-8f1b051b465dca03e0232d48e50321e7689e63ce.zip | |
New install environment to prod and dev
Also fix some docs
Diffstat (limited to '')
| -rw-r--r-- | README.rst | 6 | ||||
| -rw-r--r-- | docs/git_data.rst | 9 | ||||
| -rw-r--r-- | docs/installation.rst | 4 | ||||
| -rw-r--r-- | requirements/dev.txt | 2 | ||||
| -rw-r--r-- | test_requirements.txt | 4 |
5 files changed, 13 insertions, 12 deletions
@@ -57,11 +57,9 @@ Contribute 2. Write a test to cover new feature or to reproduce bug 3. Code with `pep8 <http://www.python.org/dev/peps/pep-0008/>`_ rules 4. Add yourself to ``AUTHORS`` -5. Pull request it +5. Pull request it to ``develop`` branch Tests ----- -Test and docs requirements are listed in ``test_requirements.txt``. -Run ``pip install -r test_requirements.txt`` to install them and ``nosetests`` -to run tests. +Run ``make init`` to install test requirements and ``nosetests`` to run tests. diff --git a/docs/git_data.rst b/docs/git_data.rst index 549420b..9045841 100644 --- a/docs/git_data.rst +++ b/docs/git_data.rst @@ -26,7 +26,7 @@ GitData .. attribute:: commits - :ref:`Commits service` + :ref:`Gitdata commits service` .. attribute:: references @@ -50,7 +50,7 @@ Blobs :members: -.. _Commits service: +.. _Gitdata commits service: Commits ------- @@ -84,3 +84,8 @@ Trees .. autoclass:: pygithub3.services.git_data.Trees :members: + +.. _github commits doc: http://developer.github.com/v3/git/commits +.. _github refs doc: http://developer.github.com/v3/git/refs +.. _github tags doc: http://developer.github.com/v3/git/tags +.. _github trees doc: http://developer.github.com/v3/git/trees diff --git a/docs/installation.rst b/docs/installation.rst index 6eccc95..0601a7e 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -22,8 +22,8 @@ If you install ``pygithub3`` with ``pip`` all is done. This is the best option. Optional ......... -The test suite uses `nose`_, `mock`_, and `unittest2`_. Compiling the -documentation requires `sphinx`_. +The test suite uses `nose`_, `mock`_, and `unittest2`_ (python 2.6). Compiling +the documentation requires `sphinx`_. Install all of these by running ``pip install -r test_requirements.txt``. Then just run ``nosetests`` to run the tests. diff --git a/requirements/dev.txt b/requirements/dev.txt index 2004d29..5b1f13b 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -2,3 +2,5 @@ nose mock +unittest2 +sphinx diff --git a/test_requirements.txt b/test_requirements.txt deleted file mode 100644 index 862d240..0000000 --- a/test_requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -nose -unittest2 -mock -sphinx |