Merge pull request #95 from bsipocz/changelog_github_issue_links

Resolving GitHub issue links in changelog

CHANGES.rst

@@ -21,8 +21,7 @@
 
 - https://pypi.org/project/pyregion/1.1.4/
 - The changelog for this release is incomplete.
-
-- Change tag attribute from string to list of strings [26]
+- Change tag attribute from string to list of strings. [#26]
 
 1.1 (March 15, 2013)
 --------------------

docs/conf.py

@@ -28,7 +28,6 @@
 import datetime
 import os
 import sys
-import warnings
 
 try:
     import astropy_helpers
@@ -48,6 +47,7 @@
 except ImportError:
     from configparser import ConfigParser
 conf = ConfigParser()
+
 conf.read([os.path.join(os.path.dirname(__file__), '..', 'setup.cfg')])
 setup_cfg = dict(conf.items('metadata'))
 
@@ -95,7 +95,7 @@
 release = package.__version__
 
 
-# -- Options for HTML output ---------------------------------------------------
+# -- Options for HTML output --------------------------------------------------
 
 # A NOTE ON HTML THEMES
 # The global astropy configuration uses a custom theme, 'bootstrap-astropy',
@@ -133,26 +133,26 @@
 htmlhelp_basename = project + 'doc'
 
 
-# -- Options for LaTeX output --------------------------------------------------
+# -- Options for LaTeX output -------------------------------------------------
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [('index', project + '.tex', project + u' Documentation',
                     author, 'manual')]
 
 
-# -- Options for manual page output --------------------------------------------
+# -- Options for manual page output -------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [('index', project.lower(), project + u' Documentation',
               [author], 1)]
 
 
-## -- Options for the edit_on_github extension ----------------------------------------
+# -- Options for the edit_on_github extension ---------------------------------
 
 if eval(setup_cfg.get('edit_on_github')):
-    extensions += ['astropy.sphinx.ext.edit_on_github']
+    extensions += ['astropy_helpers.sphinx.ext.edit_on_github']
 
     versionmod = __import__(setup_cfg['package_name'] + '.version')
     edit_on_github_project = setup_cfg['github_project']
@@ -178,4 +178,9 @@
 
 # otherwise, readthedocs.org uses their theme by default, so no need to specify it
 
+# -- Resolving issue number to links in changelog -----------------------------
+github_issues_url = 'https://github.com/{0}/issues/'.format(setup_cfg['github_project'])
+
+
+# -- Turn on nitpicky mode for sphinx (to warn about references not found) ----
 nitpicky = True