Add a fancy termshow example to the docsite. Demo the progress bar.

tbielawa · Jun 16, 2015 · 1ea3162 · 1ea3162
1 parent 0650fd2
commit 1ea3162
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/doc-requirements.txt b/doc-requirements.txt
@@ -0,0 +1 @@
+sphinxcontrib-showterm
diff --git a/docsite/source/conf.py b/docsite/source/conf.py
@@ -32,7 +32,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.mathjax']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.mathjax', 'sphinxcontrib.showterm']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docsite/source/conf.py.in b/docsite/source/conf.py.in
@@ -32,7 +32,7 @@ sys.path.insert(0, os.path.abspath('../../bitmath'))
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.mathjax']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.mathjax', 'sphinxcontrib.showterm']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docsite/source/index.rst b/docsite/source/index.rst
@@ -374,3 +374,10 @@ If ran as a script the results would be similar to this:
 
    $ python ./smalldl.py
    Bitmath Progress Bar Demo:  ||||||||||||||||||||||||||||||||||||||||| 1.58 MiB/s
+
+
+Click the **slow**, or **fast** links below to start the screen
+capture.
+
+.. showterm:: aeea3ae1b8af7f0be2fc4
+   :speed: stop