From ae70874b053a2adcfc98609adacd5785618b8e48 Mon Sep 17 00:00:00 2001 From: Luiz Carvalho Date: Jun 12 2019 18:36:18 +0000 Subject: [PATCH 1/2] Disable sphinxcontrib-issuetracker integration 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 --- diff --git a/docs/conf.py b/docs/conf.py index caa667b..41ea38c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,7 +42,6 @@ extensions = [ 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', 'sphinxcontrib.autohttp.flask', - 'sphinxcontrib.issuetracker', ] # Add any paths that contain templates here, relative to this directory. @@ -194,42 +193,3 @@ intersphinx_mapping = { 'python': ('https://docs.python.org/3/', 'python-intersphinx.inv'), 'greenwave': ('https://docs.pagure.org/greenwave/', 'greenwave-intersphinx.inv'), } - -# Configuration for issue tracker magic linking. -issuetracker = None -issuetracker_url = 'https://pagure.io/' -issuetracker_project = 'waiverdb' - -# 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) diff --git a/tox.ini b/tox.ini index aba4b9a..f34dd41 100644 --- a/tox.ini +++ b/tox.ini @@ -1,9 +1,5 @@ [tox] -envlist = flake8,lint,py36 - -# Cannot build tox here until this is merged and released -# https://github.com/ignatenkobrain/sphinxcontrib-issuetracker/pull/13 -# envlist = lint,py36,docs +envlist = flake8,lint,py36,docs # If the user is missing an interpreter, don't fail skip_missing_interpreters = True @@ -24,7 +20,6 @@ testpaths = tests/ changedir = docs deps = -rrequirements.txt - sphinxcontrib-issuetracker whitelist_externals = mkdir rm diff --git a/waiverdb.spec b/waiverdb.spec index d28aaee..f205fee 100644 --- a/waiverdb.spec +++ b/waiverdb.spec @@ -28,7 +28,6 @@ BuildRequires: python-setuptools %if %{with server} BuildRequires: python3-sphinx BuildRequires: python3-sphinxcontrib-httpdomain -BuildRequires: python3-sphinxcontrib-issuetracker BuildRequires: python3-flask BuildRequires: python3-sqlalchemy BuildRequires: python3-flask-cors @@ -112,7 +111,7 @@ sed -i 's/\.stg\.fedoraproject\.org/.fedoraproject.org/g' conf/client.conf.examp %build %if 0%{?fedora} || 0%{?rhel} > 7 %py3_build -make -C docs SPHINXOPTS="-D issuetracker_plaintext_issues=0" html man text +make -C docs html man text %else %py2_build %endif From 2dca4e51d415296baf365adc59d7b66d7d13edff Mon Sep 17 00:00:00 2001 From: Luiz Carvalho Date: Jun 12 2019 20:06:29 +0000 Subject: [PATCH 2/2] Do not run tests twice The flake8 environment does not have a corresponding [testenv:flake8] section in tox.ini. This causes the default [testenv] section to be used, causing the unit tests to execute twice. The lint environment is responsible for running flake8. Signed-off-by: Luiz Carvalho --- diff --git a/tox.ini b/tox.ini index f34dd41..7c250ab 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = flake8,lint,py36,docs +envlist = lint,py36,docs # If the user is missing an interpreter, don't fail skip_missing_interpreters = True