Documentation adjustments, move hooks to examples

README.rst

@@ -8,18 +8,20 @@ Gather status report data for given date range.
 
 Description
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 Comfortably gather status report data (e.g. list of committed
 changes) for given week, month, quarter, year or selected date
 range. By default all available stats for this week are reported.
 
 
 Examples
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Generate all stats for current week::
+
+Gather all stats for current week::
 
     status-report
 
-Generate stats for the last week::
+Gather stats for the last week::
 
     status-report last week
 
@@ -28,6 +30,7 @@ See status-report --help for complete list of available stats.
 
 Installation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 Install directly from Fedora/Copr repository or use PIP::
 
     # Basic dependencies for buiding/installing pip packages
@@ -48,12 +51,11 @@ To build and execute in a docker container, run::
 
     make run_docker
 
-See LINKS section below for more docker resources.
-
 
 Configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The config file ~/.status-report is used to store both general
+
+The config file ``~/.status-report`` is used to store both general
 settings and configuration of individual reports::
 
     [general]
@@ -88,62 +90,63 @@ config file. Use environment variable ``STATUS_REPORT_CONFIG`` to
 override the default config file location.
 
 
-Git Commit Hooks
+Contributing
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you're planning to make commits to this project, please enable
-the following git hooks::
 
-    # UPDATE according to the correct absolute git path
-    PATH = ~/status-report/git-hooks
-    ln -s $(PATH)/pre-commit.py .git/hooks/pre-commit
-    ln -s $(PATH)/commit-msg.py .git/hooks/commit-msg
+If you're planning to contribute to this project consider copying
+the following hooks into your git config::
 
+    GIT=~/git/status-report # update to your actual path
+    cp $GIT/examples/pre-commit.py $GIT/.git/hooks/pre-commit
+    cp $GIT/examples/commit-msg.py $GIT/.git/hooks/commit-msg
 
-Tests
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 To run tests using pytest::
 
-    # sudo required if not in a virtualenv
-    pip install pytest coveralls
     coverage run --source=status_report -m py.test source/tests
     coverage report
 
+Install pytest and coverage using yum::
 
-Links
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Project page:
-http://psss.fedorapeople.org/status-report/
+    yum install pytest python-coverage
 
-Release notes:
-http://psss.fedorapeople.org/status-report/notes.html
+or pip::
 
-Examples:
-http://psss.fedorapeople.org/status-report/examples/
+    # sudo required if not in a virtualenv
+    pip install pytest coveralls
 
-Download:
-http://psss.fedorapeople.org/status-report/download/
 
-Copr repo:
-http://copr.fedoraproject.org/coprs/psss/status-report/
+Links
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Git repo:
+Git:
 https://github.com/psss/status-report
 
-PIP repo:
-https://pypi.python.org/pypi/status_report/
+Docs:
+http://status-report.readthedocs.org
+
+Issues:
+https://github.com/psss/status-report/issues
 
-Docker Guides:
-https://fedoraproject.org/wiki/Docker
+Releases:
+https://github.com/psss/status-report/releases
+
+Copr:
+http://copr.fedoraproject.org/coprs/psss/status-report
+
+PIP:
+https://pypi.python.org/pypi/status_report
 
 
 Authors
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Petr Šplíchal, Karel Šrot, Lukáš Zachar, Matěj Cepl, Ondřej Pták
-and Chris Ward.
+
+Petr Šplíchal, Karel Šrot, Lukáš Zachar,
+Matěj Cepl, Ondřej Pták and Chris Ward.
 
 
 Copyright
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 Copyright (c) 2015 Red Hat, Inc. All rights reserved.
 
 This program is free software; you can redistribute it and/or
@@ -170,5 +173,5 @@ Status
 .. image:: https://img.shields.io/pypi/l/status-report.svg
     :target: https://pypi.python.org/pypi/status_report/
 
-.. image:: https://landscape.io/github/psss/status-report/master/landscape.svg
-    :target: https://landscape.io/github/psss/status-report/master
+.. image:: https://readthedocs.org/projects/status-report/badge/
+    :target: https://readthedocs.org/projects/status-report/

docs/docker.rst

@@ -0,0 +1,10 @@
+
+
+======================
+    Docker Docs
+======================
+
+A couple of useful resources:
+
+ * https://fedoraproject.org/wiki/Docker
+ * https://fedoraproject.org/wiki/Getting_started_with_docker