Merge pull request #227 from mcmtroffaes/release/2.1.3

Prepare release 2.1.3.

.travis.yml

@@ -1,29 +1,29 @@
 language: python
 dist: focal
-python:
-  - "3.9-dev"
-  - "3.8"
-  - "3.7"
-  - "3.6"
-  - "pypy3"
+jobs:
+  include:
+  - python: "3.9"
+  - python: "3.9"
+    env: SPHINX_VERSION=2.1
+  - python: "3.8"
+  - python: "3.7"
+  - python: "3.6"
+  - python: "pypy3"
 branches:
   only:
     - develop
 install:
   - "pip install pybtex"  # for dev version: git+https://bitbucket.org/pybtex-devs/pybtex
-  - "pip install codecov pytest pytest-cov" # required for tests
+  - "pip install codecov pytest pytest-cov"  # required for tests
+  - "if [[ -n \"$SPHINX_VERSION\" ]]; then pip install sphinx==$SPHINX_VERSION; fi"
   - "pip install ."
-  - "if [[ $TRAVIS_PYTHON_VERSION == '3.8' ]]; then pip install check-manifest flake8; fi"
+  - "if [[ $TRAVIS_PYTHON_VERSION == '3.9' ]]; then pip install check-manifest flake8; fi"
 script:
-  - "if [[ $TRAVIS_PYTHON_VERSION == '3.8' ]]; then check-manifest; fi"
-  - "if [[ $TRAVIS_PYTHON_VERSION == '3.8' ]]; then flake8; fi"
+  - "if [[ $TRAVIS_PYTHON_VERSION == '3.9' ]]; then check-manifest; fi"
+  - "if [[ $TRAVIS_PYTHON_VERSION == '3.9' ]]; then flake8; fi"
   - "pushd doc"
-  - "if [[ $TRAVIS_PYTHON_VERSION == '3.8' ]]; then make html; fi"
+  - "if [[ $TRAVIS_PYTHON_VERSION == '3.9' ]]; then make html; fi"
   - "popd"
-  - "pushd test"
   - "pytest --cov=sphinxcontrib.bibtex --cov=natbib"
-  - "popd"
 after_success:
-  - "pushd test"
   - "codecov"
-  - "popd"

CHANGELOG.rst

@@ -1,6 +1,8 @@
-2.1.3 (in development)
+2.1.3 (1 January 2021)
 ----------------------
 
+* Sphinx 2.1 or later is now formally required (up from 2.0).
+
 * Fix unresolved references when running the latex build immediately after
   the html build, or when rerunning the html build after deleting the
   generated html files without deleting the pickled doctrees/environment

LICENSE.rst

@@ -1,5 +1,5 @@
 | sphinxcontrib-bibtex is a Sphinx extension for BibTeX style citations
-| Copyright (c) 2011-2020 by Matthias C. M. Troffaes
+| Copyright (c) 2011-2021 by Matthias C. M. Troffaes
 | All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

VERSION

@@ -1 +1 @@
-2.1.3a0
+2.1.3

doc/conf.py

@@ -13,7 +13,7 @@
 # -- General configuration -----------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-# needs_sphinx = '1.0'
+needs_sphinx = '2.1'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@@ -31,7 +31,7 @@
 
 # General information about the project.
 project = u'sphinxcontrib-bibtex'
-copyright = u'2011-2020, Matthias C. M. Troffaes'
+copyright = u'2011-2021, Matthias C. M. Troffaes'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

requirements.txt

@@ -1,4 +1,4 @@
 docutils>=0.8
 pybtex>=0.20
 pybtex-docutils>=0.2.2
-Sphinx>=2.0
+Sphinx>=2.1

setup.cfg

@@ -6,3 +6,8 @@ cover-html=1
 
 [mypy-pybtex.*]
 ignore_missing_imports = True
+
+[coverage:report]
+exclude_lines =
+    pragma: no cover
+    if TYPE_CHECKING:

sphinxcontrib/bibtex/directives.py

@@ -20,7 +20,7 @@
 from .bibfile import normpath_filename
 from .nodes import bibliography as bibliography_node
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from sphinx.environment import BuildEnvironment
     from .domain import BibtexDomain
 

sphinxcontrib/bibtex/domain.py

@@ -27,7 +27,7 @@
 
 from .bibfile import BibFile, normpath_filename, process_bibfile
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from pybtex.database import Entry
     from pybtex.style import FormattedEntry
     from pybtex.style.formatting import BaseStyle

sphinxcontrib/bibtex/roles.py

@@ -14,7 +14,7 @@
 from pybtex.plugin import find_plugin
 from sphinx.roles import XRefRole
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from .domain import BibtexDomain
 
 

test/conftest.py

@@ -9,3 +9,8 @@
 @pytest.fixture(scope='session')
 def rootdir():
     return path(__file__).parent.abspath() / 'roots'
+
+
+# monkey patch for path class on old sphinx versions
+if not hasattr(path, "read_text"):
+    path.read_text = path.text

test/test_parallel.py

@@ -6,10 +6,11 @@
 
 @pytest.mark.skipif(not parallel_available,
                     reason='sphinx parallel builds not available')
-@pytest.mark.sphinx('html', testroot='parallel', parallel=4)
+@pytest.mark.sphinx('html', testroot='parallel')
 def test_parallel(make_app, app_params):
     args, kwargs = app_params
     app0 = make_app(*args, **kwargs)
+    app0.parallel = 4
     app0.build()
     assert not app0._warning.getvalue()
     # update files to trigger merge of citations domain data