doc: upgrade sphinx 1.1.3 -> 1.2.3

Fixes JuliaLang#8596, fixes JuliaLang#8276.
Carreau · Oct 7, 2014 · ca362a4 · ca362a4
1 parent 1785871
commit ca362a4
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 63 deletions.
diff --git a/doc/Makefile b/doc/Makefile
@@ -23,7 +23,7 @@ $(ACTIVATE):
 	touch -c $@
 
 $(SPHINX_BUILD): $(ACTIVATE) requirements.txt
-	. $(ACTIVATE) && pip install sphinx==1.1.3 \
+	. $(ACTIVATE) && pip install sphinx==1.2.3 \
 	              && pip install -r requirements.txt
 	touch -c $@
 

diff --git a/doc/helpdb.jl b/doc/helpdb.jl
@@ -209,7 +209,7 @@
 
 "),
 
-("Base","≡","is(x, y) -> Bool
+("Base","is","is(x, y) -> Bool
 ===(x, y) -> Bool
 ≡(x, y) -> Bool
 
@@ -837,7 +837,7 @@
 
 "),
 
-("Base","∌","in(item, collection) -> Bool
+("Base","in","in(item, collection) -> Bool
 ∈(item, collection) -> Bool
 ∋(collection, item) -> Bool
 ∉(item, collection) -> Bool
@@ -1291,7 +1291,7 @@
 
 "),
 
-("Base","⊊","issubset(a, b)
+("Base","issubset","issubset(a, b)
 ⊆(A, S) -> Bool
 ⊈(A, S) -> Bool
 ⊊(A, S) -> Bool
@@ -1333,13 +1333,15 @@
 
 "),
 
-("Base","Dict","Dict()
+("Base","Dict","Dict([itr])
 
-   \"Dict{K,V}()\" constructs a hash
+   \"Dict{K,V}()\" constructs a hash table with keys of type K and
+   values of type V. Given a single iterable argument, constructs a
+   \"Dict\" whose key-value pairs are taken from 2-tuples
+   \"(key,value)\" generated by the argument.
 
-   table with keys of type K and values of type V. The literal syntax
-   is \"{\"A\"=>1, \"B\"=>2}\" for a \"Dict{Any,Any}\", or
-   \"[\"A\"=>1, \"B\"=>2]\" for a \"Dict\" of inferred type.
+   Alternatively, a sequence of pair arguments may be passed:
+   \"Dict{K,V}(\"A\"=>1, \"B\"=>2)\".
 
 "),
 
@@ -1465,7 +1467,7 @@
 
 "),
 
-("Base","∪","union(s1, s2...)
+("Base","union","union(s1, s2...)
 ∪(s1, s2)
 
    Construct the union of two or more sets. Maintains order with
@@ -1479,7 +1481,7 @@
 
 "),
 
-("Base","∩","intersect(s1, s2...)
+("Base","intersect","intersect(s1, s2...)
 ∩(s1, s2)
 
    Construct the intersection of two or more sets. Maintains order and
@@ -1551,7 +1553,7 @@
 
 "),
 
-("Base","⊆","issubset(A, S) -> Bool
+("Base","issubset","issubset(A, S) -> Bool
 ⊆(A, S) -> Bool
 
    True if A is a subset of or equal to S.
@@ -1773,10 +1775,10 @@
    * \"casefold=true\": perform Unicode case folding, e.g. for case-
      insensitive string comparison
 
-   * \"newline2lf=true\", \"newline2ls=true\", or \"newline2ps=true\":
-     convert various newline sequences (LF, CRLF, CR, NEL) into a
-     linefeed (LF), line-separation (LS), or paragraph-separation (PS)
-     character, respectively
+   * \"newline2lf=true\", \"newline2ls=true\", or
+     \"newline2ps=true\": convert various newline sequences (LF, CRLF,
+     CR, NEL) into a linefeed (LF), line-separation (LS), or
+     paragraph-separation (PS) character, respectively
 
    * \"stripmark=true\": strip diacritical marks (e.g. accents)
 
@@ -3601,7 +3603,7 @@ popdisplay(d::Display)
 
 "),
 
-("Base","÷","div(a, b)
+("Base","div","div(a, b)
 ÷(a, b)
 
    Compute a/b, truncating to an integer.
@@ -3760,7 +3762,7 @@ popdisplay(d::Display)
 
 "),
 
-("Base","≠","!=(x, y)
+("Base","!=","!=(x, y)
 ≠(x, y)
 
    Not-equals comparison operator. Always gives the opposite answer as
@@ -3769,14 +3771,14 @@ popdisplay(d::Display)
 
 "),
 
-("Base","≡","===(x, y)
+("Base","===","===(x, y)
 ≡(x, y)
 
    See the \"is()\" operator
 
 "),
 
-("Base","≢","!==(x, y)
+("Base","!==","!==(x, y)
 ≢(x, y)
 
    Equivalent to \"!is(x, y)\"
@@ -3793,7 +3795,7 @@ popdisplay(d::Display)
 
 "),
 
-("Base","≤","<=(x, y)
+("Base","<=","<=(x, y)
 ≤(x, y)
 
    Less-than-or-equals comparison operator.
@@ -3808,7 +3810,7 @@ popdisplay(d::Display)
 
 "),
 
-("Base","≥",">=(x, y)
+("Base",">=",">=(x, y)
 ≥(x, y)
 
    Greater-than-or-equals comparison operator.
@@ -3821,7 +3823,7 @@ popdisplay(d::Display)
 
 "),
 
-("Base",".≠",".!=(x, y)
+("Base",".!=",".!=(x, y)
 .≠(x, y)
 
    Element-wise not-equals comparison operator.
@@ -3834,7 +3836,7 @@ popdisplay(d::Display)
 
 "),
 
-("Base",".≤",".<=(x, y)
+("Base",".<=",".<=(x, y)
 .≤(x, y)
 
    Element-wise less-than-or-equals comparison operator.
@@ -3847,7 +3849,7 @@ popdisplay(d::Display)
 
 "),
 
-("Base",".≥",".>=(x, y)
+("Base",".>=",".>=(x, y)
 .≥(x, y)
 
    Element-wise greater-than-or-equals comparison operator.
@@ -4700,12 +4702,13 @@ popdisplay(d::Display)
       julia> gcdx(240, 46)
       (2,-9,47)
 
-   Note: Bézout coefficients are *not* uniquely defined. \"gcdx\" returns
-     the minimal Bézout coefficients that are computed by the extended
-     Euclid algorithm. (Ref: D. Knuth, TAoCP, 2/e, p. 325, Algorithm
-     X.) These coefficients \"u\" and \"v\" are minimal in the sense
-     that |u| < |\\frac y d and |v| < |\\frac x d. Furthermore, the
-     signs of \"u\" and \"v\" are chosen so that \"d\" is positive.
+   Note: Bézout coefficients are *not* uniquely defined. \"gcdx\"
+     returns the minimal Bézout coefficients that are computed by the
+     extended Euclid algorithm. (Ref: D. Knuth, TAoCP, 2/e, p. 325,
+     Algorithm X.) These coefficients \"u\" and \"v\" are minimal in
+     the sense that |u| < |\\frac y d and |v| < |\\frac x d.
+     Furthermore, the signs of \"u\" and \"v\" are chosen so that
+     \"d\" is positive.
 
 "),
 
@@ -5359,7 +5362,7 @@ popdisplay(d::Display)
 
 "),
 
-("Base","π","pi
+("Base","pi","pi
 π
 
    The constant pi
@@ -7773,8 +7776,8 @@ popdisplay(d::Display)
 
    Creates a symbolic link to \"target\" with the name \"link\".
 
-   Note: This function raises an error under operating systems that do not
-     support soft symbolic links, such as Windows XP.
+   Note: This function raises an error under operating systems that
+     do not support soft symbolic links, such as Windows XP.
 
 "),
 
@@ -9067,7 +9070,7 @@ popdisplay(d::Display)
 
 "),
 
-("Dates","millisecond","year(dt::TimeType) -> Int64
+("Dates","year","year(dt::TimeType) -> Int64
 month(dt::TimeType) -> Int64
 week(dt::TimeType) -> Int64
 day(dt::TimeType) -> Int64
@@ -9080,7 +9083,7 @@ millisecond(dt::TimeType) -> Int64
 
 "),
 
-("Dates","Millisecond","Year(dt::TimeType) -> Year
+("Dates","Year","Year(dt::TimeType) -> Year
 Month(dt::TimeType) -> Month
 Week(dt::TimeType) -> Week
 Day(dt::TimeType) -> Day
@@ -9329,7 +9332,7 @@ Millisecond(dt::TimeType) -> Millisecond
 
 "),
 
-("Dates","Millisecond","Year(v)
+("Dates","Year","Year(v)
 Month(v)
 Week(v)
 Day(v)
@@ -9779,15 +9782,15 @@ Millisecond(v)
 
 "),
 
-("Base","⋅","dot(x, y)
+("Base","dot","dot(x, y)
 ⋅(x, y)
 
    Compute the dot product. For complex vectors, the first vector is
    conjugated.
 
 "),
 
-("Base","×","cross(x, y)
+("Base","cross","cross(x, y)
 ×(x, y)
 
    Compute the cross product of two 3-vectors.
@@ -9851,23 +9854,33 @@ Millisecond(v)
       +-------------+-----------------------------------------+--------+--------------------------+---------------+
       | Component   | Description                             | \\\"LU\\\" | \\\"LU{T,Tridiagonal{T}}\\\" | \\\"UmfpackLU\\\" |
       +-------------+-----------------------------------------+--------+--------------------------+---------------+
+      | \\\"F[:L]\\\"   | \\\"L\\\" (lower triangular) part of \\\"LU\\\" | ✓      |                          | ✓             |
       +-------------+-----------------------------------------+--------+--------------------------+---------------+
+      | \\\"F[:U]\\\"   | \\\"U\\\" (upper triangular) part of \\\"LU\\\" | ✓      |                          | ✓             |
       +-------------+-----------------------------------------+--------+--------------------------+---------------+
+      | \\\"F[:p]\\\"   | (right) permutation \\\"Vector\\\"          | ✓      |                          | ✓             |
       +-------------+-----------------------------------------+--------+--------------------------+---------------+
+      | \\\"F[:P]\\\"   | (right) permutation \\\"Matrix\\\"          | ✓      |                          |               |
       +-------------+-----------------------------------------+--------+--------------------------+---------------+
+      | \\\"F[:q]\\\"   | left permutation \\\"Vector\\\"             |        |                          | ✓             |
       +-------------+-----------------------------------------+--------+--------------------------+---------------+
+      | \\\"F[:Rs]\\\"  | \\\"Vector\\\" of scaling factors           |        |                          | ✓             |
       +-------------+-----------------------------------------+--------+--------------------------+---------------+
+      | \\\"F[:(:)]\\\" | \\\"(L,U,p,q,Rs)\\\" components             |        |                          | ✓             |
       +-------------+-----------------------------------------+--------+--------------------------+---------------+
 
       +--------------------+--------+--------------------------+---------------+
       | Supported function | \\\"LU\\\" | \\\"LU{T,Tridiagonal{T}}\\\" | \\\"UmfpackLU\\\" |
       +--------------------+--------+--------------------------+---------------+
+      | \\\"/\\\"              | ✓      |                          |               |
       +--------------------+--------+--------------------------+---------------+
       | \\\"\\\\\\\"             | ✓      | ✓                        | ✓             |
       +--------------------+--------+--------------------------+---------------+
+      | \\\"cond\\\"           | ✓      |                          | ✓             |
       +--------------------+--------+--------------------------+---------------+
       | \\\"det\\\"            | ✓      | ✓                        | ✓             |
       +--------------------+--------+--------------------------+---------------+
+      | \\\"size\\\"           | ✓      | ✓                        |               |
       +--------------------+--------+--------------------------+---------------+
 
 "),
@@ -9978,7 +9991,9 @@ Millisecond(v)
       +-------------+-----------------------------------------------+--------------------+-----------------------+--------------------+
       | \\\"F[:R]\\\"   | \\\"R\\\" (upper right triangular) part of \\\"QR\\\" | ✓                  | ✓                     | ✓                  |
       +-------------+-----------------------------------------------+--------------------+-----------------------+--------------------+
+      | \\\"F[:p]\\\"   | pivot \\\"Vector\\\"                              |                    |                       | ✓                  |
       +-------------+-----------------------------------------------+--------------------+-----------------------+--------------------+
+      | \\\"F[:P]\\\"   | (pivot) permutation \\\"Matrix\\\"                |                    |                       | ✓                  |
       +-------------+-----------------------------------------------+--------------------+-----------------------+--------------------+
 
    The following functions are available for the \"QR\" objects:
@@ -9991,13 +10006,13 @@ Millisecond(v)
    \"Q\" matrix can be converted into a regular matrix with \"full()\"
    which has a named argument \"thin\".
 
-   Note: \"qrfact\" returns multiple types because LAPACK uses several
-     representations that minimize the memory storage requirements of
-     products of Householder elementary reflectors, so that the \"Q\"
-     and \"R\" matrices can be stored compactly rather as two separate
-     dense matrices.The data contained in \"QR\" or \"QRPivoted\" can
-     be used to construct the \"QRPackedQ\" type, which is a compact
-     representation of the rotation matrix:
+   Note: \"qrfact\" returns multiple types because LAPACK uses
+     several representations that minimize the memory storage
+     requirements of products of Householder elementary reflectors, so
+     that the \"Q\" and \"R\" matrices can be stored compactly rather
+     as two separate dense matrices.The data contained in \"QR\" or
+     \"QRPivoted\" can be used to construct the \"QRPackedQ\" type,
+     which is a compact representation of the rotation matrix:
 
            Q = \\prod_{i=1}^{\\min(m,n)} (I - \\tau_i v_i v_i^T)
 
@@ -10015,14 +10030,15 @@ Millisecond(v)
      representation [Bischof1987]. (The LAPACK documentation uses
      \"V\" in lieu of \"Y\".)
 
-   [Bischof1987] C Bischof and C Van Loan, The WY representation for
-                 products of Householder matrices, SIAM J Sci Stat
-                 Comput 8 (1987), s2-s13. doi:10.1137/0908009
+   [Bischof1987] C Bischof and C Van Loan, The WY
+                 representation for products of Householder matrices,
+                 SIAM J Sci Stat Comput 8 (1987), s2-s13.
+                 doi:10.1137/0908009
 
-   [Schreiber1989] R Schreiber and C Van Loan, A storage-efficient WY
-                   representation for products of Householder
-                   transformations, SIAM J Sci Stat Comput 10 (1989),
-                   53-57. doi:10.1137/0910005
+   [Schreiber1989] R Schreiber and C Van Loan, A
+                   storage-efficient WY representation for products of
+                   Householder transformations, SIAM J Sci Stat Comput
+                   10 (1989), 53-57. doi:10.1137/0910005
 
 "),
 
@@ -10700,7 +10716,8 @@ Millisecond(v)
         problems and \"nev+2 <= ncv <= n\" for other problems; default
         is \"ncv = max(20,2*nev+1)\".
 
-      * \"which\": type of eigenvalues to compute. See the note below.
+      * \"which\": type of eigenvalues to compute. See the note
+        below.
 
         +-----------+-----------------------------------------------------------------------------------------------------------------------------+
         | \\\"which\\\" | type of eigenvalues                                                                                                         |
@@ -10730,8 +10747,8 @@ Millisecond(v)
         (forward) iterations. Otherwise, find eigenvalues close to
         \"sigma\" using shift and invert iterations.
 
-      * \"ritzvec\": Returns the Ritz vectors \"v\" (eigenvectors) if
-        \"true\"
+      * \"ritzvec\": Returns the Ritz vectors \"v\" (eigenvectors)
+        if \"true\"
 
       * \"v0\": starting vector from which to start the iterations
 
@@ -10741,11 +10758,11 @@ Millisecond(v)
    \"niter\" and the number of matrix vector multiplications
    \"nmult\", as well as the final residual vector \"resid\".
 
-   Note: The \"sigma\" and \"which\" keywords interact: the description of
-     eigenvalues searched for by \"which\" do _not_ necessarily refer
-     to the eigenvalues of \"A\", but rather the linear operator
-     constructed by the specification of the iteration mode implied by
-     \"sigma\".
+   Note: The \"sigma\" and \"which\" keywords interact: the
+     description of eigenvalues searched for by \"which\" do _not_
+     necessarily refer to the eigenvalues of \"A\", but rather the
+     linear operator constructed by the specification of the iteration
+     mode implied by \"sigma\".
 
      +-----------------+------------------------------------+------------------------------------+
      | \\\"sigma\\\"       | iteration mode                     | \\\"which\\\" refers to eigenvalues of |

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,2 +1,2 @@
--e git+https://github.com/JuliaLang/JuliaDoc.git#egg=JuliaDoc
--e git+https://github.com/snide/sphinx_rtd_theme.git#egg=sphinx_rtd_theme
+-e git+https://github.com/JuliaLang/JuliaDoc.git@0dd9903f12f21140d46ceae9b30088ec40e353d6#egg=JuliaDoc
+-e git+https://github.com/snide/sphinx_rtd_theme.git@21e875d3a53ce897089ad690d897252f6063349d#egg=sphinx_rtd_theme