Skip to content

Commit

Permalink
DEV: improve spin docs command
Browse files Browse the repository at this point in the history
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 committed Sep 15, 2023
1 parent 44fe37c commit 4893b24
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 16 deletions.
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

0 comments on commit 4893b24

Please sign in to comment.