#441 Disable sphinxcontrib-issuetracker integration
Merged 4 years ago by lucarval. Opened 4 years ago by lucarval.

file modified
+1 -2
@@ -96,8 +96,7 @@ 

          sh '''

          sudo dnf install -y \

              python3-sphinx \

-             python3-sphinxcontrib-httpdomain \

-             python3-sphinxcontrib-issuetracker

+             python3-sphinxcontrib-httpdomain

          '''

          sh 'DEV=true GREENWAVE_CONFIG=$(pwd)/conf/settings.py.example make -C docs html'

          archiveArtifacts artifacts: 'docs/_build/html/**'

file modified
+1 -3
@@ -10,7 +10,5 @@ 

  fedora-messaging

  

  # Documentation build requirements

- # Pin sphinx until https://bitbucket.org/birkenfeld/sphinx-contrib/issues/182 is fixed and released

- sphinx==1.5.6

+ sphinx

  sphinxcontrib-httpdomain

- sphinxcontrib-issuetracker

file modified
-39
@@ -37,7 +37,6 @@ 

      'sphinx.ext.viewcode',

      'sphinx.ext.napoleon',

      'sphinxcontrib.autohttp.flask',

-     'sphinxcontrib.issuetracker',

  ]

  

  # Add any paths that contain templates here, relative to this directory.
@@ -185,41 +184,3 @@ 

  # Example configuration for intersphinx: refer to the Python standard library.

  intersphinx_mapping = {'https://docs.python.org/3/': 'python-intersphinx.inv'}

  

- # Configuration for issue tracker magic linking.

- issuetracker = None

- issuetracker_url = 'https://pagure.io/'

- issuetracker_project = 'greenwave'

- 

- # Until Pagure support is merged: https://github.com/ignatenkobrain/sphinxcontrib-issuetracker/pull/15

- import requests

- from sphinxcontrib.issuetracker import Issue

- PAGURE_URL = '{0.url}/{0.project}/issue/{1}'

- PAGURE_API_URL = '{0.url}/api/0/{0.project}/issue/{1}'

- HEADERS = {

-     'User-Agent': 'sphinxcontrib-issuetracker'

- }

- def get(app, url):

-     try:

-         response = requests.get(url, headers=HEADERS)

-         if response.status_code == requests.codes.ok:

-             return response

-         elif response.status_code != requests.codes.not_found:

-             msg = 'GET {0.url} failed with code {0.status_code}'

-             app.warn(msg.format(response))

-     except IOError as e:

-         msg = 'GET {0} failed with error: {1}'

-         app.warn(msg.format(url, e))

- def lookup_pagure_issue(app, tracker_config, issue_id):

-     if not tracker_config.url:

-         raise ValueError('URL required, try: https://pagure.io/')

-     issue_url = PAGURE_URL.format(tracker_config, issue_id)

-     response = get(app, PAGURE_API_URL.format(tracker_config, issue_id))

-     if response:

-         title = response.json()['title']

-         closed = response.json()['status'] != 'Open'

-         return Issue(id=issue_id, title=title, closed=closed, url=issue_url)

-     else:

-         return Issue(id=issue_id, title=None, closed=False, url=issue_url)

- 

- def setup(app):

-     app.connect('issuetracker-lookup-issue', lookup_pagure_issue)

This extension appears to no longer be maintained. The following issue
prevents adopting a newer version of Sphinx:
https://github.com/ignatenkobrain/sphinxcontrib-issuetracker/issues/23

Signed-off-by: Luiz Carvalho lucarval@redhat.com

Pull-Request has been merged by lucarval

4 years ago