Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add editable tip and docs typo fix to README #2568

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add editable tip and docs typo fix to README #2568

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
49c8d68
Add editable tip
pamelafox Nov 13, 2024
f232bfd
Fix tox command
pamelafox Nov 13, 2024
e308a47
Update README.md
pamelafox Nov 21, 2024
cff28d4
Merge branch 'master' into readmestep
pamelafox Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,20 +98,32 @@ should be included, feel free to make the changes and submit a *pull-request*.

To build the docs in your local environment, from the project directory:

tox -e docs-html
```bash
tox -e docs
pamelafox marked this conversation as resolved.
Show resolved Hide resolved
```

## Installation

To install Flask-Admin, simply:

pip install flask-admin
```shell
pip install flask-admin
```

Or alternatively, you can download the repository and install manually
by doing:

git clone https://github.com/pallets-eco/flask-admin.git
cd flask-admin
pip install .
```shell
git clone https://github.com/pallets-eco/flask-admin.git
cd flask-admin
pip install .
```

If you are contributing a bug fix or a new feature, you can install the app in editable mode:

```shell
pip install -e ".[all]"
```

## Tests

Expand Down