Skip to content

Commit d12c2e7

Browse files
committed
Fix docs
1 parent 557a4f9 commit d12c2e7

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

Diff for: {{cookiecutter.project_slug}}/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,27 @@ Moved to [settings](https://cookiecutter-django.readthedocs.io/en/latest/1-getti
2222

2323
- To create a **superuser account**, use this command:
2424

25-
$ python manage.py createsuperuser
25+
$ uv run python manage.py createsuperuser
2626

2727
For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.
2828

2929
### Type checks
3030

3131
Running type checks with mypy:
3232

33-
$ mypy {{cookiecutter.project_slug}}
33+
$ uv run mypy {{cookiecutter.project_slug}}
3434

3535
### Test coverage
3636

3737
To run the tests, check your test coverage, and generate an HTML coverage report:
3838

39-
$ coverage run -m pytest
40-
$ coverage html
41-
$ open htmlcov/index.html
39+
$ uv run coverage run -m pytest
40+
$ uv run coverage html
41+
$ uv run open htmlcov/index.html
4242

4343
#### Running tests with pytest
4444

45-
$ pytest
45+
$ uv run pytest
4646

4747
### Live reloading and Sass CSS compilation
4848

@@ -58,7 +58,7 @@ To run a celery worker:
5858

5959
```bash
6060
cd {{cookiecutter.project_slug}}
61-
celery -A config.celery_app worker -l info
61+
uv run celery -A config.celery_app worker -l info
6262
```
6363

6464
Please note: For Celery's import magic to work, it is important _where_ the celery commands are run. If you are in the same folder with _manage.py_, you should be right.
@@ -67,14 +67,14 @@ To run [periodic tasks](https://docs.celeryq.dev/en/stable/userguide/periodic-ta
6767

6868
```bash
6969
cd {{cookiecutter.project_slug}}
70-
celery -A config.celery_app beat
70+
uv run celery -A config.celery_app beat
7171
```
7272

7373
or you can embed the beat service inside a worker with the `-B` option (not recommended for production use):
7474

7575
```bash
7676
cd {{cookiecutter.project_slug}}
77-
celery -A config.celery_app worker -B -l info
77+
uv run celery -A config.celery_app worker -B -l info
7878
```
7979

8080
{%- endif %}

Diff for: {{cookiecutter.project_slug}}/docs/howto.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Documentation can be written as rst files in `{{cookiecutter.project_slug}}/docs
99
{% if cookiecutter.use_docker == 'n' %}
1010
To build and serve docs, use the command::
1111

12-
make livehtml
12+
uv run make livehtml
1313

1414
from inside the `{{cookiecutter.project_slug}}/docs` directory.
1515
{% else %}
@@ -35,7 +35,7 @@ For an in-use example, see the `page source <_sources/users.rst.txt>`_ for :ref:
3535
To compile all docstrings automatically into documentation source files, use the command:
3636
::
3737

38-
make apidocs
38+
uv run make apidocs
3939

4040
{% if cookiecutter.use_docker == 'y' %}
4141
This can be done in the docker container:

0 commit comments

Comments
 (0)