Skip to content

Commit d7a0ae7

Browse files
yakkyyakky
committed
Update docs
1 parent 5dcbc2c commit d7a0ae7

4 files changed

Lines changed: 64 additions & 36 deletions

File tree

‎AUTHORS‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,23 @@ Written by
22
----------
33
Andrea Stagi <[email protected]>
44

5+
Maintainer
6+
----------
7+
Iacopo Spalletti <[email protected]>
8+
59
Contributors
610
------------
7-
Moritz Lipp <[email protected]>
8-
Marco Federighi <[email protected]>
9-
Erik Westrup <[email protected]>
10-
Jordi Llonch <[email protected]>
1111
Alejandro Guirao <[email protected]>
12-
Jesús Espino <[email protected]>
13-
Dennis Markgraf <[email protected]>
14-
Paolo Romolini <[email protected]>
12+
Christoph Meißner <[email protected]>
13+
Daniel Federschmidt <[email protected]>
1514
David Barragán Merino <[email protected]>
16-
Iacopo Spalletti <[email protected]>
15+
Dennis Markgraf <[email protected]>
16+
Erik Westrup <[email protected]>
17+
Jesús Espino <[email protected]>
18+
Jordi Llonch <[email protected]>
19+
Marco Federighi <[email protected]>
20+
Maxence Adnot <[email protected]>
21+
Moritz Lipp <[email protected]>
1722
Mustafa Furkan Kaptan <[email protected]>
18-
Christoph Meißner <[email protected]>
19-
Maxence Adnot <[email protected]>
23+
Paolo Romolini <[email protected]>
24+
Robin Gustafsson <[email protected]>

‎CONTRIBUTING.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Contributing
33
============
44

55
Contributions are welcome, and they are greatly appreciated! Every
6-
little bit helps, and credit will always be given.
6+
little bit helps, and credit will always be given.
77

88
You can contribute in many ways:
99

@@ -13,7 +13,7 @@ Types of Contributions
1313
Report Bugs
1414
~~~~~~~~~~~
1515

16-
Report bugs at https://github.com/nephila/djangocms-helper/issues.
16+
Report bugs at https://github.com/nephila/python-taiga/issues.
1717

1818
If you are reporting a bug, please include:
1919

@@ -36,14 +36,14 @@ is open to whoever wants to implement it.
3636
Write Documentation
3737
~~~~~~~~~~~~~~~~~~~
3838

39-
djangocms-helper could always use more documentation, whether as part of the
40-
official djangocms-helper docs, in docstrings, or even on the web in blog posts,
39+
python-taiga could always use more documentation, whether as part of the
40+
official python-taiga docs, in docstrings, or even on the web in blog posts,
4141
articles, and such.
4242

4343
Submit Feedback
4444
~~~~~~~~~~~~~~~
4545

46-
The best way to send feedback is to file an issue at https://github.com/nephila/djangocms-helper/issues.
46+
The best way to send feedback is to file an issue at https://github.com/nephila/python-taiga/issues.
4747

4848
If you are proposing a feature:
4949

@@ -55,17 +55,17 @@ If you are proposing a feature:
5555
Get Started!
5656
------------
5757

58-
Ready to contribute? Here's how to set up `djangocms-helper` for local development.
58+
Ready to contribute? Here's how to set up `python-taiga` for local development.
5959

60-
1. Fork the `djangocms-helper` repo on GitHub.
60+
1. Fork the `python-taiga` repo on GitHub.
6161
2. Clone your fork locally::
6262

63-
$ git clone [email protected]:your_name_here/djangocms-helper.git
63+
$ git clone [email protected]:your_name_here/python-taiga.git
6464

6565
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
6666

67-
$ mkvirtualenv djangocms-helper
68-
$ cd djangocms-helper/
67+
$ mkvirtualenv python-taiga
68+
$ cd python-taiga/
6969
$ python setup.py develop
7070

7171
4. Create a branch for local development::
@@ -81,7 +81,7 @@ tests, including testing other Python versions with tox::
8181
$ python setup.py test
8282
$ tox
8383

84-
To get flake8 and tox, just pip install them into your virtualenv.
84+
To get flake8 and tox, just pip install them into your virtualenv.
8585

8686
6. Commit your changes and push your branch to GitHub::
8787

@@ -100,6 +100,6 @@ Before you submit a pull request, check that it meets these guidelines:
100100
2. If the pull request adds functionality, the docs should be updated. Put
101101
your new functionality into a function with a docstring, and add the
102102
feature to the list in README.rst.
103-
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check
104-
https://travis-ci.org/nephila/djangocms-helper/pull_requests
103+
3. The pull request should work for Python 2.7, 3,4, 3.5 and 3.6. Check
104+
https://travis-ci.org/nephila/python-taiga/pull_requests
105105
and make sure that the tests pass for all supported Python versions.

‎HISTORY.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@ History
1111
* Add support for multiple authentication backends
1212
* Add support for self-signed and not verified SSL certificates
1313
* Add support for webhooks
14+
* Drop nose
15+
* Add configuration to generate debian packages
16+
* Move documentation to readthedocs (https://python-taiga.readthedocs.io/)
17+
* Fix documentation building
18+
* Add tests for codestyle, docs
19+
* Fix packaging shippind tests
20+
* Add tests for python 3.5/3.6
21+
* Improve compatibility with pyjwkest
1422

1523
******************
1624
0.8.6 (2016-08-26)

‎README.rst‎

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
python-taiga
22
============
33

4-
|Build Status| |Codecov.io Status| |Latest Version| |Supported Python
5-
versions| |License| |Downloads|
4+
|Gitter| |PyPiVersion| |PyVersion| |Status| |TestCoverage| |CodeClimate| |License|
65

76
A module for using the `Taiga REST
87
API <http://taigaio.github.io/taiga-doc/dist/api.html>`__.
@@ -211,15 +210,31 @@ You can access the history of issues, tasks, userstories and wiki pages:
211210
212211
You can find a complete example in demo.py.
213212

214-
.. |Build Status| image:: http://img.shields.io/travis/nephila/python-taiga.svg?branch=master
215-
:target: https://travis-ci.org/nephila/python-taiga
216-
.. |Codecov.io Status| image:: https://img.shields.io/codecov/c/github/nephila/python-taiga.svg
217-
:target: http://codecov.io/github/nephila/python-taiga?branch=master
218-
.. |Latest Version| image:: https://img.shields.io/pypi/v/python-taiga.svg
219-
:target: https://pypi.python.org/pypi/python-taiga/
220-
.. |Supported Python versions| image:: https://img.shields.io/badge/python-2.6%2C%202.7%2C%203.3%2C%203.4%2C%203.5-blue.svg
221-
:target: https://pypi.python.org/pypi/python-taiga/
222-
.. |License| image:: https://img.shields.io/github/license/nephila/python-taiga.svg
223-
:target: https://pypi.python.org/pypi/python-taiga/
224-
.. |Downloads| image:: https://img.shields.io/pypi/dm/python-taiga.svg
213+
214+
.. |Gitter| image:: https://img.shields.io/badge/GITTER-join%20chat-brightgreen.svg?style=flat-square
215+
:target: https://gitter.im/nephila/applications
216+
:alt: Join the Gitter chat
217+
218+
.. |PyPiVersion| image:: https://img.shields.io/pypi/v/python-taiga.svg?style=flat-square
219+
:target: https://pypi.python.org/pypi/python-taiga
220+
:alt: Latest PyPI version
221+
222+
.. |PyVersion| image:: https://img.shields.io/pypi/pyversions/python-taiga.svg?style=flat-square
223+
:target: https://pypi.python.org/pypi/python-taiga
224+
:alt: Python versions
225+
226+
.. |Status| image:: https://img.shields.io/travis/nephila/python-taiga.svg?style=flat-square
227+
:target: https://travis-ci.org/nephila/python-taiga
228+
:alt: Latest Travis CI build status
229+
230+
.. |TestCoverage| image:: https://img.shields.io/coveralls/nephila/python-taiga/master.svg?style=flat-square
231+
:target: https://coveralls.io/r/nephila/python-taiga?branch=master
232+
:alt: Test coverage
233+
234+
.. |License| image:: https://img.shields.io/github/license/nephila/python-taiga.svg?style=flat-square
225235
:target: https://pypi.python.org/pypi/python-taiga/
236+
:alt: License
237+
238+
.. |CodeClimate| image:: https://codeclimate.com/github/nephila/python-taiga/badges/gpa.svg?style=flat-square
239+
:target: https://codeclimate.com/github/nephila/python-taiga
240+
:alt: Code Climate

0 commit comments

Comments
 (0)