Publishing on PyPI

@henryiii

@henryiii Is there a reason this package isn't published on PyPI? It looks like PyPI has a repo for it, but it has not been updated since 2021. Would it be possible to add API key for the PyPI project to this repo as a secret so we could write a GitHub action to publish the package to PyPI?

@wjakob

Trusted publishing would be better than an API key. ;)

I have no idea if there's a reason, the readme has had instructions for git installs for a while. @wjakob is the sole owner on PyPI.

@wjakob

+1 on trusted publishing (my bad, forgot they added this)

I think the git install is nice if one wants a bleeding-edge version, but it is convenient to have older versions easily accessible, especially if projects are stuck on an old OS or with an older Python version no longer supported by the newest versions. I'm happy to do the work to create the GitHub action to publish the package if @wjakob can help us set up trusted publising and/or add someone else to the PyPI project who can do it.

@wjakob

Just pinging @wjakob with a gentle reminder about this. We are hoping to set up trusted publishing and/or add someone else to the PyPI project who can do it.

@henryiii

This sounds like a good idea, but I won't get to this any time soon. AFAIK @henryiii has admin access to this repo.

The problem is I don't have access to the project on PyPI. :)

https://pypi.org/project/pybind11_mkdoc/

I invited you.

Thanks! The maintainer role can't add trusted publishing, though. (Or even yank releases).

https://docs.pypi.org/trusted-publishers/adding-a-publisher/

If you want to add it, it's actually quite simple, we could use cd.yml for the workflow and pypi for the environment.

@henryiii

Just pinging @henryiii and @wjakob to see where this landed and find out what else needs to be done. Please let me know if there is anything I can do to help.

@henryiii

Just pinging @henryiii @wjakob to see where this is at and find out what else needs to be done.

@henryiii

I added @henryiii as co-owner.

@wjakob

@wjakob Excellent, thank you! @henryiii Hopefully this should be sufficient to add the trusted publishing. Please let me know if there is anything I can help with. Thanks!

I've set up trusted publishing assuming cd.yml as the workflow name, pypi as the environment (gets created automatically).

@henryiii

@henryiii Awesome! I see you've got everything squared away from #58. Would you be okay with publishing a new release, as the version currently on PyPI is from 2021. If so, do you have any opinions on what the new version number should be?

I also see you've got #59 open with some issues Fable found and have already addressed some of them in #60. Happy to wait to publish on PyPI until this is closed or more of the issues in #59 are addressed if you feel they are important.

It would be nice to address them before release, so we can release something stable (though I'm fine either way). Would you have a chance to review? If so, I can address the rest.

RE: version number, what about 3.0? (2.6.2 seems to be the old one).

GitHub Actions is currently really flaky, trying to release pybind11 3.1, but a runner won't pick up the job, so probably best to wait just a tiny bit before releasing anyway.

Sounds good, I'm fine waiting until we can fix all the issues in #59 to release, no rush from my end. I can review #60 in a few minutes.

Yeah, 3.0 was what I was thinking as well, since there have been a lot of changes since the last release.

@leakec

Here's a draft changelog, build using Qwen 3.8:27b in OpenCode locally, but then fixed with Claude (Qwen didn't go back far enough).

@leakec Should we put this in repo, or just have it in GH releases?

🤖 AI text below 🤖

Breaking changes

Default to -std=c++17 instead of -std=c++11 when no standard is specified (feat!: default to -std=c++17 #62).
Docstring output now uses the Google docstring style instead of the previous format (Updating docstring output format to use Google doc style #49).
Clang diagnostics are now printed to stderr, and an error diagnostic aborts the run so that
no output file is written for headers that fail to parse (feat: report clang diagnostics and fail on errors #66).
Require Python 3.9+ and drop support for older interpreters (feat: bump Python to modern versions #42).

Added

Windows support (Windows support #22).
CMake helper functions to generate the docstring header and wire up build dependencies (Adding cmake functions to generate docs #51).
A proper argparse-based command line, including support for -D definitions.
Support for clang and C++ include directories through the CLANG_INCLUDE_DIR and
CPP_INCLUDE_DIRS environment variables (add capability to add clang and c++ include dirs via environment variables #12).
Support for additional C++ include directories (Added additional C++ include directories #10).
Support for the path to the LLVM directory through an environment variable.
Support for the --width flag to control the docstring line width.
Support for the doxygen @exception command (Support doxygen @exception command #33).
Support for the doxygen @returns, @authors, and @throws commands.
Support for more doxygen directives (Add support for more doxygen directive #9).
Support doxygen @directive, not just \directive (Support @directive, not just \directive #6).
Support \p as an alias for \c.
Python 3.15 support (ci: add Python 3.15 to test matrix and classifiers #69).
The package is now typed, with strict mypy checks (feat: add strict mypy static typing #71).

Changed

Generated headers now use valid C++ identifiers (Make generated file use valid C++ identifiers #31).
EXTRA_ARGS in CMake is now a multi-value argument (fix(cmake): make EXTRA_ARGS a multi-value argument #65).
Set LIBCLANG_PATH in the environment on Linux (allow setting LIBCLANG_PATH in environment on Linux #3).
All doxygen-style comment block markers are now removed from the output.
Class and struct tags are now removed from the output.

Fixed

Improve libclang discovery on macOS and Linux (fix: improve libclang discovery on macOS and Linux #67).
Improve LLVM/libclang detection on Linux, and fail explicitly if the libclang shared
object is not found in the default locations.
Avoid collisions in suffixes for duplicate names (fix: avoid collisions in duplicate-name suffixes #61).
Keep an explicit empty value in -D definitions (fix: keep explicit empty value in -D definitions #64).
Fix issues when filenames contain spaces by removing shlex.quote (Remove shlex.quote to fix issues when filenames have spaces #38).
Fix the LLVM environment variable name in the error message (Fix LLVM environment variable name in error message #30).
Fix doxygen @warning and @note commands (Add doxygen command note and fix warning #35).
Fix class names that contain ::, which the section label pattern matched incorrectly.
Fix the missing newline after Args.
Allow special characters in one-word markup.
Create the output directory when the given directory name is empty (fix output dir creation error when dirname is empty #19, Make sure output file directory exists before trying to open file for writing. #14).
Fix the generated pybind11-mkdoc console script (Fix generated pybind11-mkdoc console script #20).
Ensure generated docstrings meet PEP 257 standards.

Performance

Use a ThreadPoolExecutor in extract_all (refactor: use ThreadPoolExecutor in extract_all #60).
Use early exits and file caches

@henryiii

@henryiii Sweet, this looks great! I'm open to either; do you have a preference? Just sticking it in GH releases is probably easiest, right?

Fine to just put it in releases for now. Would you like to make the release?

Bumping version to 3.0. See #50 (comment)

Sure thing. I've drafted a release in the releases page. I've also bumped the version to 3.0.0. Is there anything else that is needed? If not, please let me know and I'll switch the release from draft to publish.

I don't think so. Go for it!

Excellent, everything worked, and I was able to pip install pybind11_mkdoc! Thanks a ton for all the work you did for this :)

Navigation Menu

Repository navigation

Publishing on PyPI #50

Breaking changes

Added

Changed

Fixed

Performance

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Publishing on PyPI #50

Description

Activity

henryiii commented on Dec 3, 2025

leakec commented on Dec 3, 2025

leakec commented on Apr 10, 2026

wjakob commented on Apr 10, 2026

henryiii commented on Apr 10, 2026

wjakob commented on Apr 10, 2026

henryiii commented on Apr 10, 2026

leakec commented on Jul 1, 2026

leakec commented on Aug 3, 2026

wjakob commented on Aug 4, 2026

leakec commented on Aug 4, 2026

henryiii commented on Aug 5, 2026

leakec commented on Aug 6, 2026

henryiii commented on Aug 6, 2026

henryiii commented on Aug 6, 2026

leakec commented on Aug 6, 2026

henryiii commented on Aug 14, 2026

Breaking changes

Added

Changed

Fixed

Performance

leakec commented on Aug 14, 2026

henryiii commented on Aug 14, 2026

leakec commented on Aug 14, 2026

henryiii commented on Aug 14, 2026

leakec commented on Aug 14, 2026

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions