Skip to content

gh-151941: Doc: fix Sphinx reference warnings in Doc/c-api/ #152044

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

Draft
Aniketsy wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

gh-151941: Doc: fix Sphinx reference warnings in Doc/c-api/ #152044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cfccca3
Doc: fix Sphinx reference warnings in Doc/c-api/
Aniketsy Jun 24, 2026
9d610be
Remove Doc/c-api/intro.rst from nitignore
Aniketsy Jun 24, 2026
22b90f8
Fix broken Sphinx references in Doc/c-api/
Aniketsy Jul 8, 2026
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
9 changes: 4 additions & 5 deletions Doc/c-api/init_config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1235,9 +1235,9 @@ PyConfig

.. c:member:: wchar_t* base_executable

Python base executable: :data:`sys._base_executable`.
Python base executable: ``sys._base_executable``.

Set by the :envvar:`__PYVENV_LAUNCHER__` environment variable.
Set by the ``__PYVENV_LAUNCHER__`` environment variable.

Set from :c:member:`PyConfig.executable` if ``NULL``.

Expand Down Expand Up @@ -1748,7 +1748,7 @@ PyConfig

* On macOS, use :envvar:`PYTHONEXECUTABLE` environment variable if set.
* If the ``WITH_NEXT_FRAMEWORK`` macro is defined, use
:envvar:`__PYVENV_LAUNCHER__` environment variable if set.
``__PYVENV_LAUNCHER__`` environment variable if set.
* Use ``argv[0]`` of :c:member:`~PyConfig.argv` if available and
non-empty.
* Otherwise, use ``L"python"`` on Windows, or ``L"python3"`` on other
Expand Down Expand Up @@ -1984,8 +1984,7 @@ PyConfig

The :mod:`warnings` module adds :data:`sys.warnoptions` in the reverse
order: the last :c:member:`PyConfig.warnoptions` item becomes the first
item of :data:`warnings.filters` which is checked first (highest
priority).
item of ``warnings.filters`` which is checked first (highest priority).

The :option:`-W` command line options adds its value to
:c:member:`~PyConfig.warnoptions`, it can be used multiple times.
Expand Down
2 changes: 1 addition & 1 deletion Doc/c-api/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1160,7 +1160,7 @@ when defined by the compiler, will also implicitly enable :c:macro:`!Py_DEBUG`.
In addition to the reference count debugging described below, extra checks are
performed. See :ref:`Python Debug Build <debug-build>` for more details.

Defining :c:macro:`Py_TRACE_REFS` enables reference tracing
Defining ``Py_TRACE_REFS`` enables reference tracing
(see the :option:`configure --with-trace-refs option <--with-trace-refs>`).
When defined, a circular doubly linked list of active objects is maintained by adding two extra
fields to every :c:type:`PyObject`. Total allocations are tracked as well. Upon
Expand Down
3 changes: 0 additions & 3 deletions Doc/tools/.nitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
# as tested on the CI via check-warnings.py in reusable-docs.yml.
# Keep lines sorted lexicographically to help avoid merge conflicts.

Doc/c-api/init_config.rst
Doc/c-api/intro.rst
Doc/c-api/stable.rst
Doc/library/ast.rst
Doc/library/asyncio-extending.rst
Doc/library/email.charset.rst
Expand Down
Loading