Skip to content

GH-121970: Rewrite the C-API annotations extension #121985

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

Merged
AA-Turner merged 9 commits into from
Jul 19, 2024
Merged

GH-121970: Rewrite the C-API annotations extension #121985

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
fd6de2f
GH-121970: Rewrite the C-API annotations extension
AA-Turner Jul 18, 2024
af3199c
Update conf.py
AA-Turner Jul 18, 2024
04d6372
fixup! add type hints
AA-Turner Jul 18, 2024
860b007
Underlines
AA-Turner Jul 19, 2024
32be4dc
Merge branch 'main' into docs/c-api-annotations
AA-Turner Jul 19, 2024
947bcf7
Expand comment
AA-Turner Jul 19, 2024
9b83e81
Use standard comments; add a cross-reference in `gen_doc_annotations`
AA-Turner Jul 19, 2024
f08eb83
Merge branch 'main' into docs/c-api-annotations
AA-Turner Jul 19, 2024
9f018dd
Run Ruff
AA-Turner Jul 19, 2024
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
6 changes: 4 additions & 2 deletions Doc/c-api/module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,8 @@ The available slot types are:
The *value* pointer of this slot must point to a function of the signature:

.. c:function:: PyObject* create_module(PyObject *spec, PyModuleDef *def)
:noindex:
:no-index-entry:
:no-contents-entry:

The function receives a :py:class:`~importlib.machinery.ModuleSpec`
instance, as defined in :PEP:`451`, and the module definition.
Expand Down Expand Up @@ -377,7 +378,8 @@ The available slot types are:
The signature of the function is:

.. c:function:: int exec_module(PyObject* module)
:noindex:
:no-index-entry:
:no-contents-entry:

If multiple ``Py_mod_exec`` slots are specified, they are processed in the
order they appear in the *m_slots* array.
Expand Down
8 changes: 5 additions & 3 deletions Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,14 +541,16 @@
}
extlinks_detect_hardcoded_links = True

# Options for extensions
# ----------------------
# Options for c_annotations
# -------------------------

# Relative filename of the data files
refcount_file = 'data/refcounts.dat'
stable_abi_file = 'data/stable_abi.dat'

# sphinxext-opengraph config
# Options for sphinxext-opengraph
# -------------------------------

ogp_site_url = 'https://docs.python.org/3/'
ogp_site_name = 'Python documentation'
ogp_image = '_static/og-image.png'
Expand Down
Loading