Skip to content

Commit

Permalink
doc: clear up some warnings from Sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
pao committed May 28, 2013
1 parent 3aa7804 commit ee461cc
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 31 deletions.
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Expand Down
58 changes: 37 additions & 21 deletions doc/manual/control-flow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -444,27 +444,43 @@ Built-in ``Exception``\ s
``Exception``\ s are thrown when an unexpected condition has occurred. The
built-in ``Exception``\ s listed below all interrupt the normal flow of control.

======================
``Exception``
----------------------
``ArgumentError``
``BoundsError``
``DivideError``
``DomainError``
``EOFError``
``ErrorException``
``InexactError``
``InterruptException``
``KeyError``
``LoadError``
``MemoryError``
``MethodError``
``OverflowError``
``ParseError``
``SystemError``
``TypeError``
``UndefRefError``
======================
+------------------------+
| ``Exception`` |
+========================+
| ``ArgumentError`` |
+------------------------+
| ``BoundsError`` |
+------------------------+
| ``DivideError`` |
+------------------------+
| ``DomainError`` |
+------------------------+
| ``EOFError`` |
+------------------------+
| ``ErrorException`` |
+------------------------+
| ``InexactError`` |
+------------------------+
| ``InterruptException`` |
+------------------------+
| ``KeyError`` |
+------------------------+
| ``LoadError`` |
+------------------------+
| ``MemoryError`` |
+------------------------+
| ``MethodError`` |
+------------------------+
| ``OverflowError`` |
+------------------------+
| ``ParseError`` |
+------------------------+
| ``SystemError`` |
+------------------------+
| ``TypeError`` |
+------------------------+
| ``UndefRefError`` |
+------------------------+

For example, the ``sqrt`` function throws a ``DomainError()`` if applied to a
negative real value::
Expand Down
14 changes: 7 additions & 7 deletions doc/manual/linear-algebra.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,19 +92,19 @@ Matrix factorizations
| Matrix type | LAPACK | Eigensystems | Singular values and vectors |
| | Name +---------+-------------+-------------+---------+-------------------+
| | | ``eig`` | ``eigvals`` | ``eigvecs`` | ``svd`` | ``svdvals`` |
+--------------------+--------+-------------------------------------+-----------------------------+
+--------------------+--------+---------+-------------+-------------+---------+-------------------+
| ``Hermitian`` | HE | | ABC | | | |
+--------------------+--------+-------------------------------------+-----------------------------+
+--------------------+--------+---------+-------------+-------------+---------+-------------------+
| ``Triangular`` | TR | | | | | |
+--------------------+--------+-------------------------------------+-----------------------------+
+--------------------+--------+---------+-------------+-------------+---------+-------------------+
| ``SymTridiagonal`` | ST | A | ABC | AD | | |
+--------------------+--------+-------------------------------------+-----------------------------+
+--------------------+--------+---------+-------------+-------------+---------+-------------------+
| ``Tridiagonal`` | GT | | | | | |
+--------------------+--------+-------------------------------------+-----------------------------+
+--------------------+--------+---------+-------------+-------------+---------+-------------------+
| ``Bidiagonal`` | BD | | | | A | A |
+--------------------+--------+-------------------------------------+-----------------------------+
+--------------------+--------+---------+-------------+-------------+---------+-------------------+
| ``Diagonal`` | DI | | A | | | |
+--------------------+--------+-------------------------------------+-----------------------------+
+--------------------+--------+---------+-------------+-------------+---------+-------------------+

Legend:

Expand Down
4 changes: 2 additions & 2 deletions doc/stdlib/base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ Iterable Collections
.. function:: unique(itr)

Returns an array containing only the unique elements of the iterable ``itr``, in
the order that the first of each set of equivalent elements originally appears.
the order that the first of each set of equivalent elements originally appears.

.. function:: reduce(op, v0, itr)

Expand Down Expand Up @@ -2819,7 +2819,7 @@ FFT functions in Julia are largely implemented by calling functions from `FFTW <
Compute the cross-correlation of two vectors.

Numerical Integration
-----------------
---------------------

Although several external packages are available for numeric integration
and solution of ordinary differential equations, we also provide
Expand Down

0 comments on commit ee461cc

Please sign in to comment.