Fix broken bullets by downgrading to docutils==0.16

lukelbd · lukelbd · commit 910c5ae12026 · 2021-09-17T12:59:16.000-06:00
diff --git a/ci/environment.yml b/ci/environment.yml
@@ -27,6 +27,7 @@ dependencies:
     - pytest
     - pytest-sugar
     - pyqt5
+    - docutils==0.16
     - sphinx>=3.0
     - sphinx-copybutton
     - sphinx_rtd_theme==0.4.3
diff --git a/docs/environment.yml b/docs/environment.yml
@@ -1,14 +1,13 @@
 # Hard requirements for notebook examples and documentation build
 # WARNING: Keep this up-to-date with ci/environment.yml
-# * Basemap is broken as of matplotlib >=3.3 so for documentation
+# * basemap is broken as of matplotlib >=3.3 so for documentation
 #   use 3.2.1. Probably lots of basemap holdouts for next ~5 years.
-# * PyQt5 is needed by pyplot, RTD server *happens* to already have it
+# * pyqt5 is needed by pyplot, RTD server *happens* to already have it
 #   but creating local environment will fail.
-# * Jinja >= 3.0 and nbsphinx >= 0.8.2 seem to break default ReST roles when
+# * jinja >= 3.0 and nbsphinx >= 0.8.2 seem to break default ReST roles when
 #   jupytext notebooks are converted to HTML. Interpreted as italics instead.
-# * For testing use conda create --name proplot-dev --no-default-packages followed
-#   by mamba env update --name proplot-dev --file environment.yml for speed.
-#   Making env from file fails. See: https://github.com/mamba-org/mamba/issues/633
+# * docutils >= 0.17 breaks bullet points. See the following thread
+#   for more info: https://github.com/readthedocs/sphinx_rtd_theme/issues/1115
 name: proplot-dev
 channels:
   - conda-forge
@@ -25,6 +24,7 @@ dependencies:
   - pip:
     - ..
     - pyqt5
+    - docutils==0.16
     - sphinx>=3.0
     - sphinx-copybutton
     - sphinx_rtd_theme==0.4.3
