Specify minimum version of sphinx_rtd_theme to allow most recent rele…

…ase of docutils (#1275)

* Update requirements for docutils and sphinx_rtd_theme

* Add changelog entry

* Require docutils >= 0.16

* Remove version requirement for docutils

There is a minimum version of docutils required by Sphinx, so I don't
think we need to specify one ourselves.

* Update changelog/1275.doc.rst

Co-authored-by: Erik Everson <eteverson@gmail.com>

* Update changelog entry

* Add manual links for PR and issue

Co-authored-by: Erik Everson <eteverson@gmail.com>

changelog/1275.doc.rst

@@ -0,0 +1,5 @@
+Updated the requirements for the documentation build to be no restrictions on ``docutils``
+and ``sphinx_rtd_theme >= 1.0.0``.  ``docutils == 0.17`` is not compatible with
+``sphinx_rtd_theme < 1.0`` (see
+`#1107 <https://github.com/PlasmaPy/PlasmaPy/pull/1107>`__ and
+`#1230 <https://github.com/PlasmaPy/PlasmaPy/issues/1230>`__).

requirements/docs.txt

@@ -1,7 +1,7 @@
 # these are dependencies required to build package documentation
 # ought to mirror 'docs' under options.extras_require in setup.cfg
 -r extras.txt
-docutils < 0.17
+docutils
 ipykernel
 ipywidgets
 nbsphinx
@@ -12,5 +12,5 @@ sphinx >= 3.2.0
 sphinx-changelog
 sphinx-copybutton
 sphinx-gallery
-sphinx_rtd_theme
+sphinx_rtd_theme >= 1.0.0
 towncrier >= 19.2.0

requirements/environment.yml

@@ -19,14 +19,14 @@ dependencies:
 - numba
 - pip:
   - hypothesis
-  - docutils < 0.17
+  - docutils
   - numpydoc
   - pytest
   - lmfit
-  - pygments>=2.4.1
-  - sphinx>=3.2.0
+  - pygments >= 2.4.1
+  - sphinx >= 3.2.0
   - sphinx-gallery
-  - sphinx_rtd_theme
+  - sphinx_rtd_theme >= 1.0.0
   - towncrier >= 19.2.0
   - pytest-regressions
   - notebook

setup.cfg

@@ -75,7 +75,7 @@ tests =
 docs =
   # ought to mirror requirements/docs.txt
   %(extras)s
-  docutils < 0.17
+  docutils
   ipykernel
   ipywidgets
   nbsphinx
@@ -86,7 +86,7 @@ docs =
   sphinx-changelog
   sphinx-copybutton
   sphinx-gallery
-  sphinx_rtd_theme
+  sphinx_rtd_theme >= 1.0.0
   towncrier >= 19.2.0
 developer =
   # install everything for developers