From a72ac39a2b1b6aa6a2d2d992422562d5a148d874 Mon Sep 17 00:00:00 2001 From: Josh Holbrook Date: Thu, 23 Nov 2023 08:04:15 -0900 Subject: [PATCH] Update just recipes in DEVELOPMENT.md --- DEVELOPMENT.md | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index b81157f..94f1183 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -22,25 +22,29 @@ pip-tools. To list all Just tasks, run `just --list`: ``` -iAvailable recipes: - build # Build the package - build-docs # Build the documentation - check # Check type annotations with pyright - clean # Clean up loose files - compile # Generate locked requirements files based on dependencies in pyproject.toml - console - default # By default, run checks and tests, then format and lint - docs # Live generate docs and host on a development webserver - format # Format with black and isort - install # Install all dependencies - lint # Lint with flake8 - publish # Build the package and publish it to PyPI - shell - test # Run tests with pytest - tox # Run tests using tox - update # Update all dependencies - upgrade # Update all dependencies and rebuild the environment - upload # Upload built packages +Available recipes: + build # Build the package + build-docs # Build the documentation + check # Check type annotations with pyright + clean # Clean up loose files + compile # Generate locked requirements files based on dependencies in pyproject.toml + console # Open a Jupyter console + default # By default, run checks and tests, then format and lint + docs # Live generate docs and host on a development webserver + format # Format with black and isort + install # Install all dependencies + lint # Lint with flake8 + man # Generate man page and open for preview + mkdocs # Run mkdocs + publish # Build the package and publish it to PyPI + shell # Open a bash shell with the venv activated + sphinx TARGET # Run sphinx + tag # Tag the release in git + test # Run tests with pytest + tox # Run tests using tox + update # Update all dependencies + upgrade # Update all dependencies and rebuild the environment + upload # Upload built packages ``` ### Updating Modules