[tor-commits] [stem/master] Note that Sphinx 1.3 is required in the FAQ

atagar at torproject.org atagar at torproject.org
Mon May 25 17:15:20 UTC 2015


commit 7f4a53548db501e778086f140de7a21b47465cf3
Author: Damian Johnson <atagar at torproject.org>
Date:   Mon May 25 10:09:11 2015 -0700

    Note that Sphinx 1.3 is required in the FAQ
---
 docs/change_log.rst |    1 +
 docs/conf.py        |    2 +-
 docs/faq.rst        |    2 +-
 3 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/docs/change_log.rst b/docs/change_log.rst
index 643f5bd..1d801f9 100644
--- a/docs/change_log.rst
+++ b/docs/change_log.rst
@@ -52,6 +52,7 @@ The following are only available within Stem's `git repository
  * **Website**
 
   * Example for `custom path selection for circuits <tutorials/to_russia_with_love.html#custom-path-selection>`_ (:trac:`8728`)
+  * Download link for tutorial examples (:trac:`10411`)
 
 .. _version_1.4:
 
diff --git a/docs/conf.py b/docs/conf.py
index d888402..b28a67b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -22,7 +22,7 @@ sys.path.append(os.path.abspath('.'))
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '1.3' # required for the sphinx-apidoc command
+needs_sphinx = '1.3' # required for the caption option
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
diff --git a/docs/faq.rst b/docs/faq.rst
index 2a4ec83..4d5a9a5 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -545,7 +545,7 @@ example...
 How do I build the site?
 ------------------------
 
-If you have `Sphinx <http://sphinx-doc.org/>`_ version 1.1 or later installed
+If you have `Sphinx <http://sphinx-doc.org/>`_ version 1.3 or later installed
 then building our site is as easy as...
 
 ::





More information about the tor-commits mailing list