Merge pull request #19568 from oscarbenjamin/pr_sphinx311_fix

Fix autofunction references for sphinx 3.1.1
sympy · Jun 17, 2020 · d35b1d4 · d35b1d4
2 parents a06054f + c99d3c0
commit d35b1d4
Show file tree

Hide file tree

Showing 21 changed files with 302 additions and 302 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -232,7 +232,7 @@ before_install:
         pip list | grep "numpy" && pip uninstall -y numpy;
     fi
   - if [[ "${TEST_SPHINX}" == "true" ]]; then
-      pip install sphinx==3.1.0 "docutils" doctr matplotlib sphinx-math-dollar;
+      pip install sphinx "docutils" doctr matplotlib sphinx-math-dollar;
     fi
   - if [[ "${BENCHMARK}" == "true" ]]; then
       pip install asv;

diff --git a/doc/src/modules/assumptions/index.rst b/doc/src/modules/assumptions/index.rst
@@ -20,7 +20,7 @@ Contents
 Queries are used to ask information about expressions. Main method for this
 is ask():
 
-.. autofunction:: sympy.assumptions.ask.ask
+.. autofunction:: sympy.assumptions.ask::ask
    :noindex:
 
 Querying
@@ -85,12 +85,12 @@ Extensibility
 You can define new queries or support new types by subclassing sympy.assumptions.AskHandler
  and registering that handler for a particular key by calling register_handler:
 
-.. autofunction:: sympy.assumptions.ask.register_handler
+.. autofunction:: sympy.assumptions.ask::register_handler
                   :noindex:
 
 You can undo this operation by calling remove_handler.
 
-.. autofunction:: sympy.assumptions.ask.remove_handler
+.. autofunction:: sympy.assumptions.ask::remove_handler
                   :noindex:
 
 You can support new types [1]_ by adding a handler to an existing key. In the

diff --git a/doc/src/modules/integrals/integrals.rst b/doc/src/modules/integrals/integrals.rst
@@ -102,22 +102,22 @@ SymPy first applies several heuristic algorithms, as these are the fastest:
    integrating rational functions called the Lazard-Rioboo-Trager and the
    Horowitz-Ostrogradsky algorithms. They are implemented in :func:`.ratint`.
 
-   .. autofunction:: sympy.integrals.rationaltools.ratint
-   .. autofunction:: sympy.integrals.rationaltools.ratint_ratpart
-   .. autofunction:: sympy.integrals.rationaltools.ratint_logpart
+   .. autofunction:: sympy.integrals.rationaltools::ratint
+   .. autofunction:: sympy.integrals.rationaltools::ratint_ratpart
+   .. autofunction:: sympy.integrals.rationaltools::ratint_logpart
 
 2. :func:`.trigintegrate` solves integrals of trigonometric functions using
    pattern matching
 
-   .. autofunction:: sympy.integrals.trigonometry.trigintegrate
+   .. autofunction:: sympy.integrals.trigonometry::trigintegrate
 
 3. :func:`.deltaintegrate` solves integrals with :class:`~.DiracDelta` objects.
 
-   .. autofunction:: sympy.integrals.deltafunctions.deltaintegrate
+   .. autofunction:: sympy.integrals.deltafunctions::deltaintegrate
 
 4. :func:`.singularityintegrate` is applied if the function contains a :class:`~.SingularityFunction`
 
-   .. autofunction:: sympy.integrals.singularityfunctions.singularityintegrate
+   .. autofunction:: sympy.integrals.singularityfunctions::singularityintegrate
 
 5. If the heuristic algorithms cannot be applied, :func:`.risch_integrate` is
    tried next. The *Risch algorithm* is a general method for calculating
@@ -134,8 +134,8 @@ SymPy first applies several heuristic algorithms, as these are the fastest:
    functions, powers, rational functions, algebraic functions, and function
    composition.
 
-   .. autofunction:: sympy.integrals.risch.risch_integrate
-   .. autoclass:: sympy.integrals.risch.NonElementaryIntegral
+   .. autofunction:: sympy.integrals.risch::risch_integrate
+   .. autoclass:: sympy.integrals.risch::NonElementaryIntegral
 
 6. For non-elementary definite integrals, SymPy uses so-called Meijer G-functions.
    Details are described in :ref:`g-functions`.
@@ -150,26 +150,26 @@ SymPy first applies several heuristic algorithms, as these are the fastest:
    implemented in the :func:`.manualintegrate` function. The steps for an integral
    can be seen with the :func:`.integral_steps` function.
 
-   .. autofunction:: sympy.integrals.manualintegrate.manualintegrate
-   .. autofunction:: sympy.integrals.manualintegrate.integral_steps
+   .. autofunction:: sympy.integrals.manualintegrate::manualintegrate
+   .. autofunction:: sympy.integrals.manualintegrate::integral_steps
 
 8. Finally, if all the above fail, SymPy also uses a simplified version of the
    Risch algorithm, called the *Risch-Norman algorithm*. This algorithm is tried
    last because it is often the slowest to compute. This is implemented in
    :func:`.heurisch`:
 
-   .. autofunction:: sympy.integrals.heurisch.heurisch
-   .. autofunction:: sympy.integrals.heurisch.components
+   .. autofunction:: sympy.integrals.heurisch::heurisch
+   .. autofunction:: sympy.integrals.heurisch::components
 
 API reference
 -------------
 
-.. autofunction:: sympy.integrals.integrals.integrate
-.. autofunction:: sympy.integrals.line_integrate
+.. autofunction:: sympy.integrals.integrals::integrate
+.. autofunction:: sympy.integrals.integrals::line_integrate
 
 The class :class:`~.Integral` represents an unevaluated integral and has some methods that help in the integration of an expression.
 
-.. autoclass:: sympy.integrals.integrals.Integral
+.. autoclass:: sympy.integrals.integrals::Integral
    :members:
 
    .. data:: is_commutative
@@ -179,7 +179,7 @@ The class :class:`~.Integral` represents an unevaluated integral and has some me
 :class:`~.Integral` subclasses from :class:`~.ExprWithLimits`, which is a
 common superclass of :class:`~.Integral` and :class:`~.Sum`.
 
-.. autoclass:: sympy.concrete.expr_with_limits.ExprWithLimits
+.. autoclass:: sympy.concrete.expr_with_limits::ExprWithLimits
    :members:
 
 TODO and Bugs
@@ -192,21 +192,21 @@ Numeric Integrals
 SymPy has functions to calculate points and weights for Gaussian quadrature of
 any order and any precision:
 
-.. autofunction:: sympy.integrals.quadrature.gauss_legendre
+.. autofunction:: sympy.integrals.quadrature::gauss_legendre
 
-.. autofunction:: sympy.integrals.quadrature.gauss_laguerre
+.. autofunction:: sympy.integrals.quadrature::gauss_laguerre
 
-.. autofunction:: sympy.integrals.quadrature.gauss_hermite
+.. autofunction:: sympy.integrals.quadrature::gauss_hermite
 
-.. autofunction:: sympy.integrals.quadrature.gauss_gen_laguerre
+.. autofunction:: sympy.integrals.quadrature::gauss_gen_laguerre
 
-.. autofunction:: sympy.integrals.quadrature.gauss_chebyshev_t
+.. autofunction:: sympy.integrals.quadrature::gauss_chebyshev_t
 
-.. autofunction:: sympy.integrals.quadrature.gauss_chebyshev_u
+.. autofunction:: sympy.integrals.quadrature::gauss_chebyshev_u
 
-.. autofunction:: sympy.integrals.quadrature.gauss_jacobi
+.. autofunction:: sympy.integrals.quadrature::gauss_jacobi
 
-.. autofunction:: sympy.integrals.quadrature.gauss_lobatto
+.. autofunction:: sympy.integrals.quadrature::gauss_lobatto
 
 Integration over Polytopes
 ==========================
@@ -309,4 +309,4 @@ Computing all monomials up to a maximum degree::
 API reference
 -------------
 
-.. autofunction:: sympy.integrals.intpoly.polytope_integrate
+.. autofunction:: sympy.integrals.intpoly::polytope_integrate
diff --git a/doc/src/modules/logic.rst b/doc/src/modules/logic.rst
@@ -42,55 +42,55 @@ Like most types in SymPy, Boolean expressions inherit from :class:`~.Basic`::
 The logic module also includes the following functions to derive boolean expressions
 from their truth tables-
 
-.. autofunction:: sympy.logic.boolalg.SOPform
+.. autofunction:: sympy.logic.boolalg::SOPform
 
-.. autofunction:: sympy.logic.boolalg.POSform
+.. autofunction:: sympy.logic.boolalg::POSform
 
 Boolean functions
 -----------------
 
-.. autoclass:: sympy.logic.boolalg.BooleanTrue
+.. autoclass:: sympy.logic.boolalg::BooleanTrue
 
-.. autoclass:: sympy.logic.boolalg.BooleanFalse
+.. autoclass:: sympy.logic.boolalg::BooleanFalse
 
-.. autoclass:: sympy.logic.boolalg.And
+.. autoclass:: sympy.logic.boolalg::And
 
-.. autoclass:: sympy.logic.boolalg.Or
+.. autoclass:: sympy.logic.boolalg::Or
 
-.. autoclass:: sympy.logic.boolalg.Not
+.. autoclass:: sympy.logic.boolalg::Not
 
-.. autoclass:: sympy.logic.boolalg.Xor
+.. autoclass:: sympy.logic.boolalg::Xor
 
-.. autoclass:: sympy.logic.boolalg.Nand
+.. autoclass:: sympy.logic.boolalg::Nand
 
-.. autoclass:: sympy.logic.boolalg.Nor
+.. autoclass:: sympy.logic.boolalg::Nor
 
-.. autoclass:: sympy.logic.boolalg.Implies
+.. autoclass:: sympy.logic.boolalg::Implies
 
-.. autoclass:: sympy.logic.boolalg.Equivalent
+.. autoclass:: sympy.logic.boolalg::Equivalent
 
-.. autoclass:: sympy.logic.boolalg.ITE
+.. autoclass:: sympy.logic.boolalg::ITE
 
 The following functions can be used to handle Conjunctive and Disjunctive Normal
 forms-
 
-.. autofunction:: sympy.logic.boolalg.to_cnf
+.. autofunction:: sympy.logic.boolalg::to_cnf
 
-.. autofunction:: sympy.logic.boolalg.to_dnf
+.. autofunction:: sympy.logic.boolalg::to_dnf
 
-.. autofunction:: sympy.logic.boolalg.is_cnf
+.. autofunction:: sympy.logic.boolalg::is_cnf
 
-.. autofunction:: sympy.logic.boolalg.is_dnf
+.. autofunction:: sympy.logic.boolalg::is_dnf
 
 Simplification and equivalence-testing
 --------------------------------------
 
-.. autofunction:: sympy.logic.boolalg.simplify_logic
+.. autofunction:: sympy.logic.boolalg::simplify_logic
 
 SymPy's simplify() function can also be used to simplify logic expressions to their
 simplest forms.
 
-.. autofunction:: sympy.logic.boolalg.bool_map
+.. autofunction:: sympy.logic.boolalg::bool_map
 
 Inference
 ---------
@@ -119,6 +119,6 @@ values for ``x`` that make this sentence ``True``. On the other hand, ``(x
 As you see, when a sentence is satisfiable, it returns a model that makes that
 sentence ``True``. If it is not satisfiable it will return ``False``.
 
-.. autofunction:: sympy.logic.inference.satisfiable
+.. autofunction:: sympy.logic.inference::satisfiable
 
 .. TODO: write about CNF file format
diff --git a/doc/src/modules/matrices/dense.rst b/doc/src/modules/matrices/dense.rst
@@ -4,17 +4,17 @@ Dense Matrices
 Matrix Class Reference
 ----------------------
 
-.. autoclass:: sympy.matrices.dense.Matrix
+.. autoclass:: sympy.matrices.dense::Matrix
    :members:
 
-.. autoclass:: sympy.matrices.dense.DenseMatrix
+.. autoclass:: sympy.matrices.dense::DenseMatrix
    :members:
-.. autoclass:: sympy.matrices.dense.MutableDenseMatrix
+.. autoclass:: sympy.matrices.dense::MutableDenseMatrix
    :members:
 
 ImmutableMatrix Class Reference
 -------------------------------
 
-.. autoclass:: sympy.matrices.immutable.ImmutableDenseMatrix
+.. autoclass:: sympy.matrices.immutable::ImmutableDenseMatrix
    :members:
    :noindex:
diff --git a/doc/src/modules/matrices/matrices.rst b/doc/src/modules/matrices/matrices.rst
@@ -566,41 +566,41 @@ Matrix Exceptions Reference
 Matrix Functions Reference
 --------------------------
 
-.. autofunction:: sympy.matrices.dense.matrix_multiply_elementwise
+.. autofunction:: sympy.matrices.dense::matrix_multiply_elementwise
 
-.. autofunction:: sympy.matrices.dense.zeros
+.. autofunction:: sympy.matrices.dense::zeros
 
-.. autofunction:: sympy.matrices.dense.ones
+.. autofunction:: sympy.matrices.dense::ones
 
-.. autofunction:: sympy.matrices.dense.eye
+.. autofunction:: sympy.matrices.dense::eye
 
-.. autofunction:: sympy.matrices.dense.diag
+.. autofunction:: sympy.matrices.dense::diag
 
-.. autofunction:: sympy.matrices.dense.jordan_cell
+.. autofunction:: sympy.matrices.dense::jordan_cell
 
-.. autofunction:: sympy.matrices.dense.hessian
+.. autofunction:: sympy.matrices.dense::hessian
 
-.. autofunction:: sympy.matrices.dense.GramSchmidt
+.. autofunction:: sympy.matrices.dense::GramSchmidt
 
-.. autofunction:: sympy.matrices.dense.wronskian
+.. autofunction:: sympy.matrices.dense::wronskian
 
-.. autofunction:: sympy.matrices.dense.casoratian
+.. autofunction:: sympy.matrices.dense::casoratian
 
-.. autofunction:: sympy.matrices.dense.randMatrix
+.. autofunction:: sympy.matrices.dense::randMatrix
 
 Numpy Utility Functions Reference
 ---------------------------------
 
-.. autofunction:: sympy.matrices.dense.list2numpy
+.. autofunction:: sympy.matrices.dense::list2numpy
 
-.. autofunction:: sympy.matrices.dense.matrix2numpy
+.. autofunction:: sympy.matrices.dense::matrix2numpy
 
-.. autofunction:: sympy.matrices.dense.symarray
+.. autofunction:: sympy.matrices.dense::symarray
 
-.. autofunction:: sympy.matrices.dense.rot_axis1
+.. autofunction:: sympy.matrices.dense::rot_axis1
 
-.. autofunction:: sympy.matrices.dense.rot_axis2
+.. autofunction:: sympy.matrices.dense::rot_axis2
 
-.. autofunction:: sympy.matrices.dense.rot_axis3
+.. autofunction:: sympy.matrices.dense::rot_axis3
 
 .. autofunction:: a2idx
diff --git a/doc/src/modules/matrices/sparse.rst b/doc/src/modules/matrices/sparse.rst
@@ -12,5 +12,5 @@ SparseMatrix Class Reference
 
 ImmutableSparseMatrix Class Reference
 -------------------------------------
-.. autoclass:: sympy.matrices.immutable.ImmutableSparseMatrix
+.. autoclass:: sympy.matrices.immutable::ImmutableSparseMatrix
    :members:
diff --git a/doc/src/modules/matrices/sparsetools.rst b/doc/src/modules/matrices/sparsetools.rst
@@ -5,8 +5,8 @@ Sparse Tools
 
 .. module:: sympy.matrices.sparsetools
 
-.. automethod:: sympy.matrices.sparsetools._doktocsr
+.. automethod:: sympy.matrices.sparsetools::_doktocsr
 
-.. automethod:: sympy.matrices.sparsetools._csrtodok
+.. automethod:: sympy.matrices.sparsetools::_csrtodok
 
-.. automethod:: sympy.matrices.sparsetools.banded
+.. automethod:: sympy.matrices.sparsetools::banded