FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Fix Sphinx warnings on unknown targets by vstinner · Pull Request #107164 · python/cpython · GitHub

/ cpython Public

Fix Sphinx warnings on unknown targets - #107164

Closed
vstinner wants to merge 1 commit into
python:mainfrom
vstinner:fix_doc_id
Closed

Fix Sphinx warnings on unknown targets#107164
vstinner wants to merge 1 commit into
python:mainfrom
vstinner:fix_doc_id

Conversation

vstinner commented Jul 23, 2023
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Fix warnings like:

  • py:data reference target not found: Py_Version
  • c:func reference target not found: malloc

📚 Documentation preview 📚: https://cpython-previews--107164.org.readthedocs.build/

Fix warnings like:

* py:data reference target not found: Py_Version
* c:func reference target not found: malloc

Copy link
Copy Markdown
Contributor

See also gh-107063

Copy link
Copy Markdown
Contributor

... and gh-107062

Copy link
Copy Markdown
Member Author

Docs / Docs job failed with:

Warning: c:identifier reference target not found: va_list
Warning: c:identifier reference target not found: va_list
Warning: c:identifier reference target not found: va_list

Copy link
Copy Markdown
Contributor

Docs / Docs job failed with:

Warning: c:identifier reference target not found: va_list
Warning: c:identifier reference target not found: va_list
Warning: c:identifier reference target not found: va_list

No, you misread the CI information. This is what you need to fix ;)

Congratulations! You improved:

Doc/c-api/apiabiversion.rst

Please remove from Doc/tools/.nitignore

Comment thread Doc/c-api/arg.rst
for the ``s`` and ``s#`` formats, the required data is copied. Buffers provided
by the caller are never referenced by the objects created by
:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`malloc`
:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`!malloc`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This is not needed; malloc is in the nitignore list in Doc/conf.py.

Suggested change
:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`!malloc`
:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`malloc`

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I saw warnings on this function on this documentation page. Maybe the PR was outdated, I don't recall the details.

I didn't know nitignore, that sounds very useful!

Comment thread Doc/c-api/arg.rst
:c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`!malloc`
and passes the allocated memory to :c:func:`Py_BuildValue`, your code is
responsible for calling :c:func:`free` for that memory once
responsible for calling :c:func:`!free` for that memory once

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Ditto. See Doc/conf.py

Suggested change
responsible for calling :c:func:`!free` for that memory once
responsible for calling :c:func:`free` for that memory once

Copy link
Copy Markdown
Member Author

I reworked this change into a serie of changes: I created issue #107298. I abandon this PR.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants


Back | FazBrowse Home | New Git URL