8000 DOC: fix a few doc build issues on 1.26.x and update `spin docs` command/docs by rgommers · Pull Request #24718 · numpy/numpy · GitHub
[go: up one dir, main page]

Skip to content

DOC: fix a few doc build issues on 1.26.x and update spin docs command/docs #24718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions .spin/cmds.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,8 @@ def build(ctx, meson_args, jobs=None, clean=False, verbose=False):
default="auto",
help="Number of parallel build jobs"
)
@click.option(
"--install-deps/--no-install-deps",
default=False,
help="Install dependencies before building"
)
@click.pass_context
def docs(ctx, sphinx_target, clean, first_build, jobs, install_deps):
def docs(ctx, sphinx_target, clean, first_build, jobs):
"""📖 Build Sphinx documentation

By default, SPHINXOPTS="-W", raising errors on warnings.
Expand All @@ -97,13 +92,12 @@ def docs(ctx, sphinx_target, clean, first_build, jobs, install_deps):

spin docs TARGET

"""
if sphinx_target not in ('targets', 'help'):
if install_deps:
util.run(['pip', 'install', '-q', '-r', 'doc_requirements.txt'])
E.g., to build a zipfile of the html docs for distribution:

spin docs dist

"""
meson.docs.ignore_unknown_options = True
del ctx.params['install_deps']
ctx.forward(meson.docs)


Expand Down
9 changes: 4 additions & 5 deletions doc/HOWTO_RELEASE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,11 @@ github actions.

Building docs
-------------
We are no longer building ``PDF`` files. All that will be needed is
We are no longer building pdf files, only html docs. The ``numpy-html.zip``
needed to upload to the doc server can be built with ``spin docs dist``.

- virtualenv (pip).

The other requirements will be filled automatically during the documentation
build process.
To install the necessary doc build dependencies into your development
environment, run ``pip install -r doc_requirements.txt``.


Uploading to PyPI
Expand Down
6 changes: 5 additions & 1 deletion doc/source/reference/random/examples/cython/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@
Extending `numpy.random` via Cython
-----------------------------------

.. _note:

Starting with NumPy 1.26.0, Meson is the default build system for NumPy.
See :ref:`distutils-status-migration`.

.. toctree::
setup.py.rst
meson.build.rst
extending.pyx
extending_distributions.pyx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
setup.py
--------
meson.build
-----------

.. literalinclude:: ../../../../../../numpy/random/_examples/cython/setup.py
.. literalinclude:: ../../../../../../numpy/random/_examples/cython/meson.build
:language: python
6 changes: 3 additions & 3 deletions doc/source/user/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Building NumPy requires the following software installed:
can be used, including optimized LAPACK libraries such as OpenBLAS or MKL.
The choice and location of these libraries as well as include paths and
other such build options can be specified in a ``.pc`` file, as documented in
:ref:`scipy:using-pkg-config-to-detect-libraries-in-a-nonstandard-location`.
:ref:`scipy:building-blas-and-lapack`.

4) Cython

Expand Down Expand Up @@ -138,7 +138,7 @@ file.
Cross compilation
-----------------

For cross compilation instructions, see :doc:`scipy:cross_compilation` and the
`Meson documentation <meson>`_.
For cross compilation instructions, see :doc:`scipy:building/cross_compilation`
and the `Meson documentation <meson>`_.

.. _meson: https://mesonbuild.com/Cross-compilation.html#cross-compilation
0