mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
1ac94b5f44
* Initial commit for django modutils and django_command module * Fixed sanity, param settings required * add stdout, stderr and cmd to django module output * add examples and return docs to djando_command module * multiple minor adjustments * fix typo * Update plugins/modules/django_command.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/django_command.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/django_command.py Co-authored-by: Felix Fontein <felix@fontein.de> * move note to seealso * add xfailing test * Update plugins/doc_fragments/django.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/doc_fragments/django.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
53 lines
1.9 KiB
Python
53 lines
1.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2024, Alexei Znamensky <russoz@gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
DOCUMENTATION = r'''
|
|
options:
|
|
venv:
|
|
description:
|
|
- Use the the Python interpreter from this virtual environment.
|
|
- Pass the path to the root of the virtualenv, not the C(bin/) directory nor the C(python) executable.
|
|
type: path
|
|
settings:
|
|
description:
|
|
- Specifies the settings module to use.
|
|
- The value will be passed as is to the C(--settings) argument in C(django-admin).
|
|
type: str
|
|
required: true
|
|
pythonpath:
|
|
description:
|
|
- Adds the given filesystem path to the Python import search path.
|
|
- The value will be passed as is to the C(--pythonpath) argument in C(django-admin).
|
|
type: path
|
|
traceback:
|
|
description:
|
|
- Provides a full stack trace in the output when a C(CommandError) is raised.
|
|
type: bool
|
|
verbosity:
|
|
description:
|
|
- Specifies the amount of notification and debug information in the output of C(django-admin).
|
|
type: int
|
|
choices: [0, 1, 2, 3]
|
|
skip_checks:
|
|
description:
|
|
- Skips running system checks prior to running the command.
|
|
type: bool
|
|
|
|
|
|
notes:
|
|
- The C(django-admin) command is always executed using the C(C) locale, and the option C(--no-color) is always passed.
|
|
|
|
seealso:
|
|
- name: django-admin and manage.py in official Django documentation
|
|
description: >-
|
|
Refer to this documentation for the builtin commands and options of C(django-admin).
|
|
Please make sure that you select the right version of Django in the version selector on that page.
|
|
link: https://docs.djangoproject.com/en/5.0/ref/django-admin/
|
|
'''
|