Skip to content

Commit 3da3b83

Browse files
committed
update readme, fix rtfd build
1 parent 126bbca commit 3da3b83

File tree

2 files changed

+3
-11
lines changed

2 files changed

+3
-11
lines changed

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,9 @@ Please refer to the [full documentation](https://django-typer.readthedocs.io/) f
3232

3333
![django-typer example](https://raw.githubusercontent.com/django-commons/django-typer/main/doc/source/_static/img/closepoll_example.gif)
3434

35-
## 🚨 Deprecation Notice
35+
## 🚨 Upgrade Notice
3636

37-
**Imports from ``django_typer`` have been deprecated and will be removed in 3.0! Imports have moved to ``django_typer.management``:**
38-
39-
```python
40-
# old way
41-
from django_typer import TyperCommand, command, group, initialize, Typer
42-
43-
# new way!
44-
from django_typer.management import TyperCommand, command, group, initialize, Typer
45-
```
37+
**There are breaking changes between 2.x and 3.x, mostly involving shell tab completion. [See the changelog for migration steps]()**.
4638

4739
## Installation
4840

doc/.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ build:
1414
post_create_environment:
1515
- pip install poetry
1616
post_install:
17-
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry install -E rich
17+
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry install -E rich --with docs
1818

1919
# Build documentation in the docs/ directory with Sphinx
2020
sphinx:

0 commit comments

Comments
 (0)