-
-
Notifications
You must be signed in to change notification settings - Fork 11.9k
Closed
Labels
Description
Issue with current documentation:
I see warnings when building spin docs after pip install -r requirements/doc_requirements.txt:
reading sources... [100%] user/whatisnumpy
WARNING: error while formatting arguments for numpy.__array_namespace_info__: Handler <function update_annotations_using_type_comments at 0x72f050f6f100> for event 'autodoc-before-process-signature' threw an exception (exception: ('unterminated string literal (detected at line 2)', (2, 54)))
WARNING: error while formatting arguments for numpy.__array_namespace_info__: Handler <function update_annotations_using_type_comments at 0x72f050f6f100> for event 'autodoc-before-process-signature' threw an exception (exception: ('unterminated string literal (detected at line 2)', (2, 54)))
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] user/whatisnumpy
/home/matti/oss/numpy/benchmarks/README.rst:17: WARNING: py:obj reference target not found: asv
/home/matti/oss/numpy/doc/source/release/1.15.0-notes.rst:275: WARNING: py:obj reference target not found: opt_einsum
/home/matti/oss/numpy/doc/source/user/how-to-how-to.rst:108: WARNING: unknown document: 'numpy-tutorials:content/tutorial-style-guide'
/home/matti/oss/numpy/doc/source/user/quickstart.rst:1482: WARNING: unknown document: 'numpy-tutorials:content/tutorial-svd'
Idea or request for content:
The last two, about numpy-tutorials break CI. The tutorials site seems to have undergone some changes. The SVD link is now numpy-tutorials:tutorial-svd and the style guide is numpy-tutorials:tutorial-style-guide.
I will make a PR to fix this.
We might want to wholesale make single-backtick links to the documentation in old release notes into double-backtick code blocks to prevent bit rot.
I am not sure what is going on with __array_namespace_info__.
Edit: ahh, I built with python>3.11 which has problems that will need fixing after the 2.5.0 branch when we drop python3.11.