From b7ffeaa7c435a8db8a6d5fbd91d3cf69bcf9ee38 Mon Sep 17 00:00:00 2001 From: chrysle Date: Tue, 2 Jan 2024 15:53:33 +0100 Subject: [PATCH] Update "Running pipx From Source Tree" section --- CONTRIBUTING.md | 8 +++++--- mkdocs.yml | 1 - 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d743492915..4e74e3a9ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,12 +3,14 @@ Thanks for your interest in contributing to pipx! Everyone who interacts with the pipx project via codebase, issue tracker, chat rooms, or otherwise is expected to follow the [PSF Code of Conduct](https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md). -## Running pipx From Source Tree +## Running pipx For Development -To run the pipx executable from your source tree during development, run pipx from the src directory: +To develop `pipx`, either create a [developer environment](#creating-a-developer-environment), or perform an editable +install: ``` -python src/pipx --version +python -m pip install -e . +python -m pipx --version ``` ## Running Tests diff --git a/mkdocs.yml b/mkdocs.yml index 5081e08e3e..964fed6c6f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,7 +44,6 @@ markdown_extensions: plugins: - search: lang: en - enabled: true - gen-files: scripts: - scripts/gen_doc_pages.py