Skip to content

Commit

Permalink
Migrate docstrings closes #5
Browse files Browse the repository at this point in the history
  • Loading branch information
Krzysztof Żuraw committed Mar 11, 2017
1 parent 72865bd commit a7fd048
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 13 deletions.
31 changes: 19 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
Poznaj
======

.. image:: https://travis-ci.org/kj-wroclaw/poznaj-backend.svg?branch=master
:target: https://travis-ci.org/kj-wroclaw/poznaj-backend
.. image:: https://travis-ci.org/KlubJagiellonski/poznaj-app-backend.svg?branch=master
:target: https://travis-ci.org/KlubJagiellonski/poznaj-app-backend
:alt: Build Status

.. image:: http://poznajwroclaw-backend.readthedocs.io/en/latest/
:target: https://readthedocs.org/projects/poznajwroclaw-backend/badge/?version=latest
.. image:: https://readthedocs.org/projects/poznaj-wrocaw/badge/?version=latest
:target: http://poznaj-wrocaw.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://codecov.io/gh/kj-wroclaw/poznaj-backend/branch/master/graph/badge.svg
:target: https://codecov.io/gh/kj-wroclaw/poznaj-backend
.. image:: https://codecov.io/gh/KlubJagiellonski/poznaj-app-backend/branch/master/graph/badge.svg
:target: https://codecov.io/gh/KlubJagiellonski/poznaj-app-backend
:alt: Codecoverage Status

.. image:: https://pyup.io/repos/github/klubjagiellonski/poznaj-app-backend/shield.svg
:target: https://pyup.io/repos/github/klubjagiellonski/poznaj-app-backend/
:alt: Updates

.. image:: https://pyup.io/repos/github/klubjagiellonski/poznaj-app-backend/python-3-shield.svg
:target: https://pyup.io/repos/github/klubjagiellonski/poznaj-app-backend/
:alt: Python 3

This `Django`_ project includes code for backend of Poznaj Wrocław application. It tries to follow
`12 Factor App Guinness <https://12factor.net/>`_.
Expand Down Expand Up @@ -40,8 +47,8 @@ Documentation

Documentation for this project is available in the `docs`_ directory and `online`_.

.. _docs: https://github.com/kj-wroclaw/poznaj-backend/tree/master/docs
.. _online: http://poznaj-backend.readthedocs.io/en/latest/index.html
.. _docs: https://github.com/KlubJagiellonski/poznaj-app-backend/tree/master/docs
.. _online: http://poznaj-wrocaw.readthedocs.io/en/latest/


If you would like to browse the documentation locally, you can do so with `sphinx`:
Expand All @@ -61,21 +68,21 @@ If you would like to browse the documentation locally, you can do so with `sphin
Getting help
------------

Use the `issue tracker <https://github.com/kj-wroclaw/poznaj-backend/issues>`_ to follow the development conversation.
If you find a bug not listed in the issue tracker, please `file a bug report <https://github.com/kj-wroclaw/poznaj-backend/issues/new>`_.
Use the `issue tracker <https://github.com/KlubJagiellonski/poznaj-app-backend/issues>`_ to follow the development conversation.
If you find a bug not listed in the issue tracker, please `file a bug report <https://github.com/KlubJagiellonski/poznaj-app-backend/issues/new>`_.

Getting involved
----------------

We welcome your feedback and contributions. See the `contribution guidelines`_ for more details.

.. _contribution guidelines: https://github.com/kj-wroclaw/poznaj-backend/blob/master/.github/CONTRIBUTING.md
.. _contribution guidelines: https://github.com/KlubJagiellonski/poznaj-app-backend/blob/master/.github/CONTRIBUTING.md


License
-------

1. `LICENSE <https://github.com/kj-wroclaw/poznaj-backend/blob/master/LICENSE>`_
1. `LICENSE <https://github.com/KlubJagiellonski/poznaj-app-backend/blob/master/LICENSE>`_

Credits
-------
Expand Down
4 changes: 4 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Changelog
All enhancements and patches to Poznaj backend will be documented in this file.
This project adheres to `Semantic Versioning <http://semver.org/>`_.

v1.3.0 (2017-03-11)
+++++++++++++++++++
* Migrate docstrings @krzysztofzuraw

v1.2.0 (2017-03-05)
+++++++++++++++++++
* Stories can be filtered by lat/long @krzysztofzuraw
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Clone the repository
Using the console, navigate to the root directory in which your projects live and clone this project's repository:
::

$ git clone git@github.com:kj-wroclaw/poznaj-backend.git
$ git clone git@github.com:KlubJagiellonski/poznaj-app-backend.git
$ cd poznaj-backend

You may also wish to fork the repository on GitHub and clone the resultant personal fork.
Expand Down

0 comments on commit a7fd048

Please sign in to comment.