Merge pull request #513 from librosa/docs-updates

Docs updates

docs/Makefile

@@ -4,6 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
+SPHINXVBUILD   = sphinx-versioning
 PAPER         =
 BUILDDIR      = _build
 
@@ -151,3 +152,9 @@ doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
 	      "results in $(BUILDDIR)/doctest/output.txt."
+
+html_version:
+	$(SPHINXVBUILD) build . _build/html
+
+html_version_deploy:
+	$(SPHINXVBUILD) push . gh-pages .

docs/conf.py

@@ -374,3 +374,11 @@ def __getattr__(cls, name):
 #texinfo_show_urls = 'footnote'
 
 autodoc_member_order = 'bysource'
+
+# Sphinx-contrib versioning
+import re
+scv_whitelist_branches = ('master',)
+scv_whitelist_tags = (re.compile(r'^v?0\.[45]\.\d+(rc\d+)?$'),)
+scv_greatest_tag = True
+scv_banner_greatest_tag = True
+scv_show_banner = True

docs/tutorial.rst

@@ -280,5 +280,4 @@ resulting in a feature matrix ``beat_features`` of dimension
 More examples
 -------------
 
-More example scripts are provided in the `examples
-<https://github.com/librosa/librosa/tree/master/examples>`_ folder.
+More example scripts are provided in the `example gallery <https://librosa.github.io/librosa_gallery/>`_.

setup.py

@@ -42,7 +42,8 @@
     ],
     extras_require={
         'docs': ['numpydoc', 'sphinx!=1.3.1', 'sphinx_rtd_theme',
-                 'matplotlib >= 2.0.0'],
+                 'matplotlib >= 2.0.0',
+                 'sphinxcontrib-versioning >= 2.2.1'],
         'numba': ['numba >= 0.25'],
         'tests': ['matplotlib >= 2.0.0'],
         'display': ['matplotlib >= 1.5'],