DOC: use sphinx.ext.ifconfig to hide dev-related things

tacaswell · tacaswell · commit 310b00468255 · 2019-04-14T21:18:37.000-04:00
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -16,24 +16,26 @@ For API changes in older versions see
 Changes for the latest version are listed below. For new features that were
 added to Matplotlib, see :ref:`whats-new`.
 
-.. note::
+.. ifconfig:: releaselevel == 'dev'
 
-   The list below is a table of contents of individual files from the
-   'next_api_changes' folder.
+   .. note::
 
-   When a release is made
+      The list below is a table of contents of individual files from the
+      'next_api_changes' folder.
 
-    - All the files in 'next_api_changes/' should be moved to a single file in
-      'prev_api_changes/'.
-    - The include directive below should be changed to point to the new file
-      created in the previous step.
-    - This note, and the toctree below should be commented out.
+      When a release is made
 
+       - All the files in 'next_api_changes/' should be moved to a single file in
+         'prev_api_changes/'.
+       - The include directive below should be changed to point to the new file
+         created in the previous step.
+       - This note, and the toctree below should be commented out.
 
-.. toctree::
-   :glob:
-   :maxdepth: 1
 
-   next_api_changes/*
+   .. toctree::
+      :glob:
+      :maxdepth: 1
+
+      next_api_changes/*
 
 .. include:: prev_api_changes/api_changes_3.1.0.rst
diff --git a/doc/conf.py b/doc/conf.py
@@ -34,6 +34,7 @@
     'sphinx.ext.doctest',
     'sphinx.ext.inheritance_diagram',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'IPython.sphinxext.ipython_console_highlighting',
     'IPython.sphinxext.ipython_directive',
@@ -105,6 +106,7 @@ def _check_dependencies():
     'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
     'Pillow': ('https://pillow.readthedocs.io/en/stable/', None),
     'cycler': ('https://matplotlib.org/cycler', None),
+    'dateutil': ('https://dateutil.readthedocs.io/en/stable/', None),
 }
 
 
@@ -350,3 +352,10 @@ def _check_dependencies():
     'babel': r'\usepackage{babel}',
     'fontpkg': r'\setmainfont{DejaVu Serif}',
 }
+
+def setup(app):
+    if any(st in version for st in ('post', 'rc', 'alpha', 'beta')):
+        bld_type = 'dev'
+    else:
+        bld_type = 'rel'
+    app.add_config_value('releaselevel', bld_type, 'env')
