Roadmap

[ax3l]

Starting a meta-issue for roadmap brainstorming.
We should put these in issues and maybe assign them to a 2.6.0 & 3.0.0 project or milestone.

Short-Term Needs

• documentation (RTD + Sphinx?):
  • Developer facing docs (how does this project work).
    • Covering existing code with in-code docstrings.
  • A little user facing docs (usage & common workflows)
• better regeneration of silver stub files, using tox Local regeneration of stubs via tox + Clang fixes #287
• fix local stub generation for development on non-Linux platforms Local regeneration of stubs via tox + Clang fixes #287
  • It is currently not possible to build it using the scripts on Mac OS and presumable Windows due to GNU coreutils-specific instructions like (readline -m). 
• fix big bugs
  • fixing the sorting issue Sorting is causing parent-child relationships to be defined out of order #231 / Fix class sorting in case of inheritance #275 / Resolve Inheritance Sort Issue #238 and how it deals with cyclic dependencies is one of the more severe bugs we need to fix in stubgen.
  • Inconsistent current-module prefix stripping creates invalid .pyi code Fix: current-module prefix stripping #301
  • Better support for enums & unions (multiple PRs & issues)
  • NumPy transition for pybind11 v3.0 Fix numpy annotations for pybind v3.0.0 #263
  • the Better handling of hidden builtins Better handling of hidden builtins #278
• pre-commit: run ruff (formatter & linter), replacing other tools like black & flake8 Migrate to uv & ruff, remove black and isort #290 then Pre-Commit Automation #307
• checking stubs with mypy in CI

Mid or Long-Term

• support testing/dev on Windows (local stub gen)
• bugs: looking through all other smaller bugs open in our 13 PRs / 24 issues.
• type checking the project code with mypy in CI
• allow using pybind11-stubgen as a library (for customization and custom visitors)