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.

Sign up for GitHub

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

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2121dc
DOC: Fix doc build warning for random.
liang3zy22 Jul 21, 2023
44fe37c
DOC: fix two cross-references to SciPy docs in "building from source"
rgommers Sep 15, 2023
4893b24
DEV: improve `spin docs` command
rgommers Sep 15, 2023
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
Prev Previous commit
DEV: improve spin docs command 
Explain how to build a zipfile of the html docs for release purposes.
Remove --install-deps, as that is bad practice and `pip` invocations
for dependencies should not be present in this CLI.

Closes gh-24713
  • Loading branch information
@rgommers
rgommers committed Sep 15, 2023
commit 4893b24867f0bba433f9f55feb74f9b657e4a015
16 changes: 5 additions & 11 deletions .spin/cmds.py
View file
Open in desktop
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
View file
Open in desktop
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
0