8000 DOC: Fix Unknown section warning when building docs by melissawm · Pull Request #19567 · numpy/numpy · GitHub
[go: up one dir, main page]

Skip to content

DOC: Fix Unknown section warning when building docs #19567

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 1 commit into from
Jul 27, 2021

Conversation

melissawm
Copy link
Member

When building the documentation on main, the following warning turns up:

/opt/miniconda/envs/numpy-dev/lib/python3.9/site-packages/numpydoc/docscrape.py:418: UserWarning: Unknown section Numpy Blas/lapack Installation Notes in the docstring of <function show at 0x7fc4e8d0b5e0> in /home/melissa/projects/numpy/numpy/__config__.py.
  warn(msg)

In the show function at numpy.distutils.misc_util.py, there is a

    NumPy BLAS/LAPACK Installation Notes
    ------------------------------------

section (introduced in #19447), which is not recognized by numpydoc. This PR reformats the notes in the show function as a numbered list to fix the warning.

@mattip
Copy link
Member
mattip commented Jul 27, 2021

Rendered here

@mattip mattip merged commit 7b6c892 into numpy:main Jul 27, 2021
@mattip
Copy link
Member
mattip commented Jul 27, 2021

Thanks @melissawm

@melissawm melissawm deleted the docs-blas-warning branch February 8, 2022 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0