DOC: Add links to the commits where HTML themes are added

spatialaudio · Apr 26, 2016 · 6bf9100 · 6bf9100
1 parent 5da7c7a
commit 6bf9100
Showing 1 changed file with 42 additions and 14 deletions.
diff --git a/doc/usage.jupyter b/doc/usage.jupyter
@@ -124,37 +124,65 @@ markdown
 
     The `nbsphinx` extension does *not* provide its own theme, you can use any of the available themes or create a custom one, if you feel like it.
 
-    The following links show how the `nbsphinx` input and output cells look like in different themes.
+    The following links show how the `nbsphinx` documentation looks like in different themes.
 
     ### Sphinx's Built-In Themes
 
-    http://nbsphinx.readthedocs.org/en/alabaster-theme/
+    * `alabaster`:
+      [example](http://nbsphinx.readthedocs.org/en/alabaster-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/alabaster-theme^...alabaster-theme)
 
-    http://nbsphinx.readthedocs.org/en/pyramid-theme/
+    * `pyramid`:
+      [example](http://nbsphinx.readthedocs.org/en/pyramid-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/pyramid-theme^...pyramid-theme)
 
-    http://nbsphinx.readthedocs.org/en/classic-theme/
+    * `classic`:
+      [example](http://nbsphinx.readthedocs.org/en/classic-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/classic-theme^...classic-theme)
 
-    http://nbsphinx.readthedocs.org/en/bizstyle-theme/
+    * `bizstyle`:
+      [example](http://nbsphinx.readthedocs.org/en/bizstyle-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/bizstyle-theme^...bizstyle-theme)
 
-    http://nbsphinx.readthedocs.org/en/haiku-theme/
+    * `haiku`:
+      [example](http://nbsphinx.readthedocs.org/en/haiku-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/haiku-theme^...haiku-theme)
 
-    http://nbsphinx.readthedocs.org/en/traditional-theme/
+    * `traditional`:
+      [example](http://nbsphinx.readthedocs.org/en/traditional-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/traditional-theme^...traditional-theme)
 
-    http://nbsphinx.readthedocs.org/en/agogo-theme/
+    * `agogo`:
+      [example](http://nbsphinx.readthedocs.org/en/agogo-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/agogo-theme^...agogo-theme)
 
     ### 3rd-Party Themes
 
-    http://nbsphinx.readthedocs.org/en/readthedocs-theme/
+    * `sphinx_rtd_theme`:
+      [example](http://nbsphinx.readthedocs.org/en/readthedocs-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/readthedocs-theme^...readthedocs-theme)
 
-    http://nbsphinx.readthedocs.org/en/bootstrap-theme/
+    * `bootstrap`:
+      [example](http://nbsphinx.readthedocs.org/en/bootstrap-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/bootstrap-theme^...bootstrap-theme)
 
-    http://nbsphinx.readthedocs.org/en/cloud-theme/
+    * `cloud`, `redcloud`:
+      [example](http://nbsphinx.readthedocs.org/en/cloud-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/cloud-theme^...cloud-theme)
 
-    http://nbsphinx.readthedocs.org/en/py3doc-enhanced-theme/
+    * `sphinx_py3doc_enhanced_theme`:
+      [example](http://nbsphinx.readthedocs.org/en/py3doc-enhanced-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/py3doc-enhanced-theme^...py3doc-enhanced-theme)
 
-    http://nbsphinx.readthedocs.org/en/basicstrap-theme/
+    * `basicstrap`:
+      [example](http://nbsphinx.readthedocs.org/en/basicstrap-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/basicstrap-theme^...basicstrap-theme)
 
-    http://nbsphinx.readthedocs.org/en/dotted-theme/
+    * `dotted`:
+      [example](http://nbsphinx.readthedocs.org/en/dotted-theme/),
+      [usage](https://github.com/spatialaudio/nbsphinx/compare/dotted-theme^...dotted-theme)
+
+    If you know of another Sphinx theme that should be included here, please open an [issue on Github](https://github.com/spatialaudio/nbsphinx/issues).
 metadata
     {
      "kernelspec": {