Skip to content

Commit 1850098

Browse files
committed
update just recipe docs
1 parent 6854f5a commit 1850098

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ The release workflow is triggered by tag creation. You must have [git tag signin
9393

9494
## Just Recipes
9595

96-
```
96+
```bash
9797
build # build src package and wheel
9898
build-docs # build the docs
9999
build-docs-html # build html documentation
@@ -111,11 +111,14 @@ clean-docs # remove doc build artifacts
111111
clean-env # remove the virtual environment
112112
clean-git-ignored # remove all git ignored files
113113
coverage # generate the test coverage report
114+
coverage-erase # erase any coverage data
114115
docs # build and open the documentation
115116
docs-live # serve the documentation, with auto-reload
117+
fetch-refs LIB # fetch the intersphinx references for the given package
116118
fix # fix formatting, linting issues and import sorting
117119
format # format the code and sort imports
118120
install *OPTS # update and install development dependencies
121+
install-basic # install without extra dependencies
119122
install-docs # install documentation dependencies
120123
install-precommit # install git pre-commit hooks
121124
install-psycopg3 # install with postgresql dependencies
@@ -124,22 +127,22 @@ install-uv # install the uv package manager
124127
lint # sort the imports and fix linting issues
125128
list-missed-tests # run the tests and report if any were not run - sanity check
126129
log-tests # run all tests and log them
127-
manage *COMMAND # run the django admin
130+
manage *COMMAND
128131
open-docs # open the html documentation
129132
precommit # run the pre-commit checks
130133
release VERSION # issue a relase for the given semver string (e.g. 2.1.0)
131134
run +ARGS # run the command in the virtual environment
132135
setup python="python" # setup the venv and pre-commit hooks
133136
sort-imports # sort the python imports
134137
test *TESTS # run tests
135-
test-all # run all tests
138+
test-all *ENV # run all tests
136139
test-bash # test bash shell completions
137140
test-fish # test fish shell completions
138141
test-lock +PACKAGES # lock to specific python and versions of given dependencies
139-
test-no-rich # run the tests that require rich not to be installed
142+
test-no-rich *ENV # run the tests that require rich not to be installed
140143
test-powershell # test powershell shell completions
141144
test-pwsh # test pwsh shell completions
142-
test-rich # run the tests that require rich to be installed
145+
test-rich *ENV # run the tests that require rich to be installed
143146
test-zsh # test zsh shell completions
144147
translate # generate translations using google translate
145148
validate_version VERSION # validate the given version string against the lib version

0 commit comments

Comments
 (0)