Skip to content

Commit 8a6e740

Browse files
authored
Update docs. (#140)
1 parent b09643b commit 8a6e740

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

docs/command-options.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
```bash
2+
python manage.py makemigrations --help
3+
4+
usage: manage.py makemigrations [-h] [--fix] [-b DEFAULT_BRANCH] [-s] [-r REMOTE] [-f] [--dry-run] [--merge] [--empty] [--noinput] [-n NAME] [--no-header] [--check]
5+
[--version] [-v {0,1,2,3}] [--settings SETTINGS] [--pythonpath PYTHONPATH] [--traceback] [--no-color] [--force-color] [--skip-checks]
6+
[app_label ...]
7+
8+
Creates new migration(s) for apps and fix conflicts.
9+
10+
positional arguments:
11+
app_label Specify the app label(s) to create migrations for.
12+
13+
optional arguments:
14+
-h, --help show this help message and exit
15+
--fix Fix migrations conflicts.
16+
-b DEFAULT_BRANCH, --default-branch DEFAULT_BRANCH
17+
The name of the default branch.
18+
-s, --skip-default-branch-update
19+
Skip pulling the latest changes from the default branch.
20+
-r REMOTE, --remote REMOTE
21+
Git remote.
22+
-f, --force-update Force update the default branch.
23+
--dry-run Just show what migrations would be made; don't actually write them.
24+
--merge Enable fixing of migration conflicts.
25+
--empty Create an empty migration.
26+
--noinput, --no-input
27+
Tells Django to NOT prompt the user for input of any kind.
28+
-n NAME, --name NAME Use this name for migration file(s).
29+
--no-header Do not add header comments to new migration file(s).
30+
--check Exit with a non-zero status if model changes are missing migrations.
31+
--version show program's version number and exit
32+
-v {0,1,2,3}, --verbosity {0,1,2,3}
33+
Verbosity level; 0=minimal output, 1=normal output, 2=verbose output, 3=very verbose output
34+
--settings SETTINGS The Python path to a settings module, e.g. "myproject.settings.main". If this isn't provided, the DJANGO_SETTINGS_MODULE environment variable will
35+
be used.
36+
--pythonpath PYTHONPATH
37+
A directory to add to the Python path, e.g. "/home/djangoprojects/myproject".
38+
--traceback Raise on CommandError exceptions
39+
--no-color Don't colorize the command output.
40+
--force-color Force colorization of the command output.
41+
--skip-checks Skip system checks.
42+
```

migration_fixer/management/commands/makemigrations.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ class Command(BaseCommand):
2727
Create a new django migration with support for fixing conflicts.
2828
"""
2929

30+
help = "Creates new migration(s) for apps and fix conflicts."
3031
success_msg = "Successfully fixed migrations."
3132

3233
def __init__(self, *args, repo=None, **kwargs):

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ markdown_extensions:
2525
- mkautodoc
2626
nav:
2727
- Home: README.md
28+
- Command Options: command-options.md
2829
- API Reference:
2930
management: makemigrations.md
3031
utils: utils.md

0 commit comments

Comments
 (0)