Skip to content

Conversation

antznette1
Copy link

  • Added a concise “Quick start (pip + meson, editable)” section to
    doc/source/development/contributing_environment.rst.
  • Included Windows-specific guidance (VS Build Tools, PATH, long paths, execution policy, and Meson editable verbosity).
  • Provided a “Next steps” sanity check and focused test command.

Motivation

  • Streamlines the dev install path using pip + Meson (PEP 517), which auto-rebuilds C/Cython on import.
  • Addresses common Windows pitfalls that frequently block first-time contributors.

Key changes

  • New quick-start code block for editable install:
    • git fetch upstream --tags
    • python -m pip install -ve . --no-build-isolation -Ceditable-verbose=true
    • Optional -Cbuilddir=".meson_build" and -Csetup-args="-Dbuildtype=debug" tips

Windows notes: Build Tools, long paths, execution policy, and MESONPY_EDITABLE_VERBOSE.

Validation steps

  • Local editable install built successfully on Windows (3.12, MSVC, Meson).
  • Sphinx html docs built locally; the new section renders correctly in:
    • doc/build/html/development/contributing_environment.html

Please note that the change is purely documentation; no API or behavior changes.
Screenshot 2025-10-09 001025
Screenshot 2025-10-09 001156
Screenshot 2025-10-09 001222

@antznette1 antznette1 closed this Oct 8, 2025
@antznette1 antznette1 deleted the doc-meson-quickstart branch October 8, 2025 23:16
@antznette1 antznette1 changed the title DOC: Add Meson editable quick-start and Windows notes to contributing_environment.rst DOC: Add Oct 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants