Skip to content

Commit 8f1b051

Browse files
committed
New install environment to prod and dev
Also fix some docs
1 parent 32ff332 commit 8f1b051

File tree

5 files changed

+13
-12
lines changed

5 files changed

+13
-12
lines changed

README.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,9 @@ Contribute
5757
2. Write a test to cover new feature or to reproduce bug
5858
3. Code with `pep8 <http://www.python.org/dev/peps/pep-0008/>`_ rules
5959
4. Add yourself to ``AUTHORS``
60-
5. Pull request it
60+
5. Pull request it to ``develop`` branch
6161

6262
Tests
6363
-----
6464

65-
Test and docs requirements are listed in ``test_requirements.txt``.
66-
Run ``pip install -r test_requirements.txt`` to install them and ``nosetests``
67-
to run tests.
65+
Run ``make init`` to install test requirements and ``nosetests`` to run tests.

docs/git_data.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ GitData
2626

2727
.. attribute:: commits
2828

29-
:ref:`Commits service`
29+
:ref:`Gitdata commits service`
3030

3131
.. attribute:: references
3232

@@ -50,7 +50,7 @@ Blobs
5050
:members:
5151

5252

53-
.. _Commits service:
53+
.. _Gitdata commits service:
5454

5555
Commits
5656
-------
@@ -84,3 +84,8 @@ Trees
8484

8585
.. autoclass:: pygithub3.services.git_data.Trees
8686
:members:
87+
88+
.. _github commits doc: http://developer.github.com/v3/git/commits
89+
.. _github refs doc: http://developer.github.com/v3/git/refs
90+
.. _github tags doc: http://developer.github.com/v3/git/tags
91+
.. _github trees doc: http://developer.github.com/v3/git/trees

docs/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ If you install ``pygithub3`` with ``pip`` all is done. This is the best option.
2222
Optional
2323
.........
2424

25-
The test suite uses `nose`_, `mock`_, and `unittest2`_. Compiling the
26-
documentation requires `sphinx`_.
25+
The test suite uses `nose`_, `mock`_, and `unittest2`_ (python 2.6). Compiling
26+
the documentation requires `sphinx`_.
2727

2828
Install all of these by running ``pip install -r test_requirements.txt``. Then
2929
just run ``nosetests`` to run the tests.

requirements/dev.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22

33
nose
44
mock
5+
unittest2
6+
sphinx

test_requirements.txt

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)