From f641cc9e066220b837946ca47959fba72e800935 Mon Sep 17 00:00:00 2001 From: Blake DeHaas Date: Mon, 9 Mar 2026 11:15:21 -0600 Subject: [PATCH 1/3] Update Developer Documentation --- docs/source/developers.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/docs/source/developers.md b/docs/source/developers.md index 99d141b..6a85a91 100644 --- a/docs/source/developers.md +++ b/docs/source/developers.md @@ -1,5 +1,9 @@ # Developer Documentation +## Environment Setup + +This repository is entirely agnostic to how developers set up their development environments. There is a provided devcontainer configuration file and we suggest using a devcontainer to set up and isolate your development environment. + ## Installing Development Dependencies Install development dependencies using `uv`` with all the extras groups: @@ -8,8 +12,14 @@ Install development dependencies using `uv`` with all the extras groups: # Install uv if you haven't already curl -LsSf https://astral.sh/uv/install.sh | sh +# Load env vars and PATH settings +source $HOME/.local/bin/env + # Install all dependencies including optional extras uv sync --all-extras + +# Activate the virtual environment +source .venv/bin/activate ``` Note: `uv` is a fast, Rust-based Python package installer and resolver that is PEP-compliant and fully compatible with pip and PyPI. @@ -31,12 +41,6 @@ To run all tests, run pytest tests ``` -To run all tests in docker containers (tests against many versions of python), run - -```bash -docker-compose up --build && docker-compose down -``` - ## Building Documentation with Sphinx Documentation is automatically built on ReadTheDocs in response to every PR and release, @@ -44,7 +48,14 @@ but you can also build it locally with: ```bash # From docs directory -make html && open build/html/index.html +make html + +# macOS +open build/html/index.html + +# Linux / WSL (devcontainer) +sudo apt install wslu +wslview build/html/index.html ``` ## Making a Pull Request From 3e462cfabbe944b2941adbd3d0297007a3e1276b Mon Sep 17 00:00:00 2001 From: Blake DeHaas Date: Mon, 9 Mar 2026 11:32:35 -0600 Subject: [PATCH 2/3] Updated Developer Documentation --- docs/source/developers.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/developers.md b/docs/source/developers.md index 6a85a91..855f8ee 100644 --- a/docs/source/developers.md +++ b/docs/source/developers.md @@ -28,10 +28,15 @@ Once the development dependencies are installed and the uv-generated `.venv` is ```bash pre-commit install + +# Linux / WSL (devcontainer) +sudo apt-get install -y libatomic1 ``` to get pre-commit hooks to automatically run the linting and formatting checks for you before each commit. +Authentication with Github is required to push to the repository. We suggest using SSH key authentication. + ## Testing Testing is run with `pytest` and the order is randomized by `pytest-randomly`. From f45c7d56c0c0ebcee4ae2b0bcf74ebf64de6fb57 Mon Sep 17 00:00:00 2001 From: Blake DeHaas Date: Tue, 7 Apr 2026 05:07:59 +0000 Subject: [PATCH 3/3] Removed environment-specific documentation --- docs/source/developers.md | 33 --------------------------------- 1 file changed, 33 deletions(-) diff --git a/docs/source/developers.md b/docs/source/developers.md index 855f8ee..bcb537b 100644 --- a/docs/source/developers.md +++ b/docs/source/developers.md @@ -4,39 +4,6 @@ This repository is entirely agnostic to how developers set up their development environments. There is a provided devcontainer configuration file and we suggest using a devcontainer to set up and isolate your development environment. -## Installing Development Dependencies - -Install development dependencies using `uv`` with all the extras groups: - -```bash -# Install uv if you haven't already -curl -LsSf https://astral.sh/uv/install.sh | sh - -# Load env vars and PATH settings -source $HOME/.local/bin/env - -# Install all dependencies including optional extras -uv sync --all-extras - -# Activate the virtual environment -source .venv/bin/activate -``` - -Note: `uv` is a fast, Rust-based Python package installer and resolver that is PEP-compliant and fully compatible with pip and PyPI. - -Once the development dependencies are installed and the uv-generated `.venv` is activated, you can run - -```bash -pre-commit install - -# Linux / WSL (devcontainer) -sudo apt-get install -y libatomic1 -``` - -to get pre-commit hooks to automatically run the linting and formatting checks for you before each commit. - -Authentication with Github is required to push to the repository. We suggest using SSH key authentication. - ## Testing Testing is run with `pytest` and the order is randomized by `pytest-randomly`.