Fix docs building on Sphinx 1.3.1 and 1.5.1 due to custom text role

b82d3fa2 · Levi Naden · 88da682c · b82d3fa2 · b82d3fa2
Commit b82d3fa2 authored Mar 03, 2017 by Levi Naden
Show whitespace changes
Inline Side-by-side

Showing with 14 additions and 2 deletions

docs-source/developerguide/conf.py docs-source/developerguide/conf.py +7 -1

docs-source/usersguide/conf.py docs-source/usersguide/conf.py +7 -1

No files found.
--- a/docs-source/developerguide/conf.py
+++ b/docs-source/developerguide/conf.py
@@ -185,10 +185,16 @@ latex_elements = {
    \\usepackage{caption}
    \\setcounter{tocdepth}{3}
    \\captionsetup[figure]{labelformat=empty}
+    % Backwards behavior for sphinx < 1.5
+    \\let\\DUspan\\null % force DUspan to be defined
    \\renewcommand{\DUspan}[2]{%
        \\IfEqCase{#1}{%
-            {code}{\\small{}\\texttt{#2}\\normalsize{}}%
+            {code}{\\small{}\\texttt{#2}\\normalsize{}}
        }[\\PackageError{DUspan}{Unrecognized option passed to DUspan: #1}{}]%
+    }%
+    % Sphinx > 1.5 behavior (github.com/sphinx-doc/sphinx/issues/2231)
+    \\newcommand{\\DUrolecode}[1]{%
+        \\small{}\\texttt{#1}\\normalsize{}%
    }%""",
 }


--- a/docs-source/usersguide/conf.py
+++ b/docs-source/usersguide/conf.py
@@ -185,10 +185,16 @@ latex_elements = {
    \\usepackage{caption}
    \\setcounter{tocdepth}{3}
    \\captionsetup[figure]{labelformat=empty}
+    % Backwards behavior for sphinx < 1.5
+    \\let\\DUspan\\null % force DUspan to be defined
    \\renewcommand{\DUspan}[2]{%
        \\IfEqCase{#1}{%
-            {code}{\\small{}\\texttt{#2}\\normalsize{}}%
+            {code}{\\small{}\\texttt{#2}\\normalsize{}}
        }[\\PackageError{DUspan}{Unrecognized option passed to DUspan: #1}{}]%
+    }%
+    % Sphinx > 1.5 behavior (github.com/sphinx-doc/sphinx/issues/2231)
+    \\newcommand{\\DUrolecode}[1]{%
+        \\small{}\\texttt{#1}\\normalsize{}%
    }%""",

 # Omit the index.