Merge pull request #101 from Nurdok/realdocs

Automatic links to GitHub issues in docs

Author: Nurdok

docs/conf.py

@@ -32,6 +32,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.coverage',
     'sphinx.ext.viewcode',
+    'sphinxcontrib.issuetracker',  # autolinks issue numbers (like #78)
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -260,3 +261,7 @@
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
+
+# sphinxcontrib.issuetracker settings
+issuetracker = 'github'
+issuetracker_project = 'GreenSteam/pep257'

docs/release_notes.rst

@@ -7,12 +7,17 @@ Current Development Version
 
 New Features
 
-* Added check D210: No whitespaces allowed surrounding docstring text (#95)
+* Added check D210: No whitespaces allowed surrounding docstring text (#95).
+
+* Added real documentation rendering using Sphinx (#100).
 
 Bug Fixes
 
-* Removed log level configuration from module level (#98)
+* Removed log level configuration from module level (#98).
 
+* D205 used to check that there was *a* blank line between the one line summary
+  and the description. It now checks that there is *exactly* one blank line
+  between them (#79).
 
 0.4.1 - January 10th, 2015
 --------------------------
@@ -35,7 +40,8 @@ New Features
 
 * Added configuration file support (#58, #87).
 
-* Added a `--count` flag that prints the number of violations found (#86, #89).
+* Added a ``--count`` flag that prints the number of violations found (#86,
+  #89).
 
 * Added support for Python 3.4, PyPy and PyPy3 (#81).
 
@@ -46,7 +52,7 @@ Bug Fixes
 * Fixed parsing various colon and parenthesis combinations in definitions
   (#82).
 
-* Allow for greater flexibility in parsing __all__ (#67).
+* Allow for greater flexibility in parsing ``__all__`` (#67).
 
 * Fixed handling of one-liner definitions (#77).
 

requirements/docs.txt

@@ -0,0 +1 @@
+sphinxcontrib-issuetracker