Skip to content

Commit

Permalink
DOC: Add new docs requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
melissawm committed Nov 22, 2022
1 parent 75d54c1 commit 45f12bd
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 12 deletions.
2 changes: 2 additions & 0 deletions doc/source/dev/core-dev/distributing.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ are:
- `PyData Sphinx theme`_ (docs)
- `Sphinx-Design`_ (docs)
- matplotlib_ (docs)
- MyST-NB_ (docs)

Furthermore of course one needs C, C++ and Fortran compilers to build SciPy,
but those we don't consider to be dependencies and are therefore not discussed
Expand Down Expand Up @@ -223,3 +224,4 @@ Wheelhouse_, see at the wheel_ and Wheelhouse_ docs.
.. _decorator: https://github.com/micheles/decorator
.. _manylinux: https://github.com/pypa/manylinux/
.. _threadpoolctl: https://github.com/joblib/threadpoolctl
.. _MyST-NB: https://myst-nb.readthedocs.io/
5 changes: 4 additions & 1 deletion doc/source/dev/toolchain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ section for an example.)
- Compilers for C, C++, Fortran code are needed, as well as for Cython & Pythran (the latter is opt-out currently)
- The Python environment needs the ``NumPy`` package to be installed.
- Testing requires the ``pytest`` Python package.
- Building the documentation requires the ``matplotlib``, Sphinx packages along with PyData theme.
- Building the documentation requires the ``matplotlib``, Sphinx and MyST-NB_ packages along with PyData theme.

.. _MyST-NB: https://myst-nb.readthedocs.io/

The tooling used to build CPython has some implications for the tooling used
in building SciPy.
Expand Down Expand Up @@ -411,6 +413,7 @@ PyData Sphinx theme Whatever recent versions work. >= 0.8.1.
Sphinx-Design Whatever recent versions work. >= 0.2.0.
numpydoc Whatever recent versions work. >= 0.8.0.
matplotlib Generally suggest >= 2.0.
MyST-NB Whatever recent versions work. >= 0.17.1
==================== =================================================

.. note::
Expand Down
4 changes: 2 additions & 2 deletions doc/source/notebooks/interp_transition_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ This notebook contains three sets of demonstrations:
- recommended replacements for `interp2d` for use in new code;
- a demonstration of failure modes of 2D FITPACK-based linear interpolation and recommended replacements.

+++
+++

## 1. How to transition away from using `interp2d`

`interp2d` silently switches between interpolation on a 2D regular grid and interpolatin 2D scattered data. The switch is based on the lengths of the (raveled) `x`, `y`, and `z` arrays. In short, for regular grid use `RectBivariateSpline`; for scattered interpolation, use the `bisprep/bisplev` combo. Below we give examples of the literal point-for-point transition, which should preserve the `interp2d` results exactly.

+++
+++

### 1.1 `interp2d` on a regular grid

Expand Down
11 changes: 2 additions & 9 deletions doc/source/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ SciPy User Guide
.. sectionauthor:: Travis E. Oliphant

SciPy is a collection of mathematical algorithms and convenience functions built
on NumPy_ . It adds significant power to the interactive Python session by
providing the user with high-level commands and classes for manipulating and
visualizing data.
on NumPy_ . It adds significant power to Python by providing the user with
high-level commands and classes for manipulating and visualizing data.

.. _NumPy: https://numpy.org

Expand Down Expand Up @@ -45,12 +44,6 @@ SciPy subpackages need to be imported separately, for example::

>>> from scipy import linalg, optimize

Because of their ubiquitousness, some of the functions in these
subpackages are also made available in the `scipy` namespace to ease
their use in interactive sessions and programs. In addition, many
basic array functions from :mod:`numpy` are also available at the
top-level of the :mod:`scipy` package.

Below, you can find the complete user guide organized by subpackages.

.. raw:: latex
Expand Down
2 changes: 2 additions & 0 deletions doc_requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ pydata-sphinx-theme==0.9.0
sphinx-design>=0.2.0
numpydoc
matplotlib>2
docutils<0.18.1
myst-nb
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ doc = [
"sphinx-design>=0.2.0",
"matplotlib>2",
"numpydoc",
"docutils<0.18.1",
"myst-nb",
]
dev = [
"mypy",
Expand Down

0 comments on commit 45f12bd

Please sign in to comment.