Add github issue link role

CHANGELOG.rst

@@ -18,33 +18,25 @@ Version 0.3.0
   :py:class:`vdirsyncer.storage.HttpStorage`,
   :py:class:`vdirsyncer.storage.CaldavStorage` and
   :py:class:`vdirsyncer.storage.CarddavStorage`,
-  see issue `#99`_ and pull request `#106`_.
+  see :gh:`99` and :ghpr:`106`.
 
-- Add ``passwordeval`` parameter to :ref:`general_config`, see issue `#108`_
+- Add ``passwordeval`` parameter to :ref:`general_config`, see :gh:`108` and
-  and pull request `#117`_.
+  :ghpr:`117`.
 
 - Emit warnings (instead of exceptions) about certain invalid responses from
-  the server, see issue `#113`_.  This is apparently required for compatibility
+  the server, see :gh:`113`.  This is apparently required for compatibility
   with Davmail.
 
-.. _`#99`: https://github.com/untitaker/vdirsyncer/issues/99
-.. _`#106`: https://github.com/untitaker/vdirsyncer/pull/106
-.. _`#108`: https://github.com/untitaker/vdirsyncer/issues/108
-.. _`#113`: https://github.com/untitaker/vdirsyncer/issues/113
-.. _`#117`: https://github.com/untitaker/vdirsyncer/pull/117
-
 Version 0.2.5
 =============
 
 *released on 27 August 2014*
 
 - Don't ask for the password of one server more than once and fix multiple
-  concurrency issues, see issue `#101`_.
+  concurrency issues, see :gh:`101`.
 
 - Better validation of DAV endpoints.
 
-.. _`#101`: https://github.com/untitaker/vdirsyncer/issues/101
-
 Version 0.2.4
 =============
 
@@ -53,22 +45,16 @@ Version 0.2.4
 - Include workaround for collection discovery with latest version of Radicale.
 
 - Include metadata files such as the changelog or license in source
-  distribution, see issues `#97`_ and `#98`_.
+  distribution, see :gh:`97` and :gh:`98`.
-
-.. _`#97`: https://github.com/untitaker/vdirsyncer/issues/97
-.. _`#98`: https://github.com/untitaker/vdirsyncer/issues/98
 
 Version 0.2.3
 =============
 
 *released on 11 August 2014*
 
-- Vdirsyncer now has a ``--version`` flag, see issue `#92`_.
+- Vdirsyncer now has a ``--version`` flag, see :gh:`92`.
 
-- Fix a lot of bugs related to special characters in URLs, see issue `#49`_.
+- Fix a lot of bugs related to special characters in URLs, see :gh:`49`.
-
-.. _`#92`: https://github.com/untitaker/vdirsyncer/issues/92
-.. _`#49`: https://github.com/untitaker/vdirsyncer/issues/49
 
 Version 0.2.2
 =============
@@ -77,16 +63,12 @@ Version 0.2.2
 
 - Remove a security check that caused problems with special characters in DAV
   URLs and certain servers. On top of that, the security check was nonsensical.
-  See issues `#87`_ and `#91`_.
+  See :gh:`87` and :gh:`91`.
 
-- Change some errors to warnings, see issue `#88`_.
+- Change some errors to warnings, see :gh:`88`.
 
 - Improve collection autodiscovery for servers without full support.
 
-.. _`#87`: https://github.com/untitaker/vdirsyncer/issues/87
-.. _`#88`: https://github.com/untitaker/vdirsyncer/issues/88
-.. _`#91`: https://github.com/untitaker/vdirsyncer/issues/91
-
 Version 0.2.1
 =============
 
@@ -116,8 +98,8 @@ Version 0.2.0
   instead of the proper etag would have been returned from the upload method.
   vdirsyncer might do unnecessary copying when upgrading to this version.
 
-- Add the storage :py:class:`vdirsyncer.storage.SingleFileStorage`. See issue
+- Add the storage :py:class:`vdirsyncer.storage.SingleFileStorage`. See
-  `#48`_.
+  :gh:`48`.
 
 - The ``collections`` parameter for pair sections now accepts the special
   values ``from a`` and ``from b`` for automatically discovering collections.
@@ -126,8 +108,6 @@ Version 0.2.0
 - The ``read_only`` parameter was added to storage sections. See
   :ref:`storage_config`.
 
-.. _`#48`: https://github.com/untitaker/vdirsyncer/issues/48
-
 Version 0.1.5
 =============
 
@@ -142,6 +122,4 @@ Version 0.1.5
 - vdirsyncer now doesn't necessarily need UIDs anymore for synchronization.
 
 - vdirsyncer now aborts if one collection got completely emptied between
-  synchronizations. See `#42`_.
+  synchronizations. See :gh:`42`.
-
-.. _`#42`: https://github.com/untitaker/vdirsyncer/issues/42

docs/conf.py

@@ -56,3 +56,32 @@ texinfo_documents = [
      u'Markus Unterwaditzer', 'vdirsyncer',
      'Synchronize calendars and contacts.', 'Miscellaneous'),
 ]
+
+
+def github_issue_role(name, rawtext, text, lineno, inliner, options={},
+                      content=()):
+    try:
+        issue_num = int(text)
+        if issue_num <= 0:
+            raise ValueError()
+    except ValueError:
+        msg = inliner.reporter.error('Invalid GitHub issue: {}'.format(text),
+                                     line=lineno)
+        prb = inliner.problematic(rawtext, rawtext, msg)
+        return [prb], [msg]
+
+    import vdirsyncer
+    from docutils import nodes
+    link = '{}/{}/{}'.format(vdirsyncer.PROJECT_HOME,
+                             'issues' if name == 'gh' else 'pull',
+                             issue_num)
+    linktext = ('issue #{}' if name == 'gh'
+                else 'pull request #{}').format(issue_num)
+    node = nodes.reference(rawtext, linktext, refuri=link,
+                           **options)
+    return [node], []
+
+
+def setup(app):
+    app.add_role('gh', github_issue_role)
+    app.add_role('ghpr', github_issue_role)

vdirsyncer/__init__.py

@@ -10,3 +10,6 @@
     :license: MIT, see LICENSE for more details.
 '''
 __version__ = '0.3.0'
+
+PROJECT_HOME = 'https://github.com/untitaker/vdirsyncer'
+DOCS_HOME = 'https://vdirsyncer.readthedocs.org/en/latest'

vdirsyncer/cli.py

@@ -13,7 +13,7 @@ import os
 import sys
 import threading
 
-from . import __version__, log
+from . import __version__, PROJECT_HOME, DOCS_HOME, log
 from .doubleclick import click
 from .storage import storage_names
 from .sync import StorageEmpty, SyncConflict, sync
@@ -33,9 +33,6 @@ except ImportError:
 
 cli_logger = log.get(__name__)
 
-PROJECT_HOME = 'https://github.com/untitaker/vdirsyncer'
-DOCS_HOME = 'https://vdirsyncer.readthedocs.org/en/latest'
-
 GENERAL_ALL = set(['status_path', 'passwordeval'])
 GENERAL_REQUIRED = set(['status_path'])