cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2024-11-26 19:44:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

Remove cookiecutter option defaults from docs

Browse Source 
Rationale: duplicate values
This commit is contained in:
Nikita P. Shupeyko 2018-05-21 21:35:49 +03:00
parent 9eebd077bd
commit ac82eab61c
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/project-generation-options.rst
View File

@ -1,31 +1,31 @@
Project Generation Options Project Generation Options
========================== ==========================
project_name [My Awesome Project]: project_name:
Your project's human-readable name, capitals and spaces allowed. Your project's human-readable name, capitals and spaces allowed.
project_slug [my_awesome_project]: project_slug:
Your project's slug without dashes or spaces. Used to name your repo Your project's slug without dashes or spaces. Used to name your repo
and in other places where a Python-importable version of your project name and in other places where a Python-importable version of your project name
is needed. is needed.
description [Behold My Awesome Project!] description:
Describes your project and gets used in places like ``README.rst`` and such. Describes your project and gets used in places like ``README.rst`` and such.
author_name [Daniel Roy Greenfeld]: author_name:
This is you! The value goes into places like ``LICENSE`` and such. This is you! The value goes into places like ``LICENSE`` and such.
email [daniel-roy-greenfeld@example.com]: email:
The email address you want to identify yourself in the project. The email address you want to identify yourself in the project.
domain_name [example.com] domain_name:
The domain name you plan to use for your project once it goes live. The domain name you plan to use for your project once it goes live.
Note that it can be safely changed later on whenever you need to. Note that it can be safely changed later on whenever you need to.
version [0.1.0] version:
The version of the project at its inception. The version of the project at its inception.
open_source_license [1] open_source_license:
A software license for the project. The choices are: A software license for the project. The choices are:
1. MIT_ 1. MIT_
@ -34,19 +34,19 @@ open_source_license [1]
4. `Apache Software License 2.0`_ 4. `Apache Software License 2.0`_
5. Not open source 5. Not open source
timezone [UTC] timezone:
The value to be used for the ``TIME_ZONE`` setting of the project. The value to be used for the ``TIME_ZONE`` setting of the project.
windows [n] windows:
Indicates whether the project should be configured for development on Windows. Indicates whether the project should be configured for development on Windows.
use_pycharm [n] use_pycharm:
Indicates whether the project should be configured for development with PyCharm_. Indicates whether the project should be configured for development with PyCharm_.
use_docker [y] use_docker:
Indicates whether the project should be configured to use Docker_ and `Docker Compose`_. Indicates whether the project should be configured to use Docker_ and `Docker Compose`_.
postgresql_version [1] postgresql_version:
Select a PostgreSQL_ version to use. The choices are: Select a PostgreSQL_ version to use. The choices are:
1. 10.3 1. 10.3
@ -57,45 +57,45 @@ postgresql_version [1]
6. 9.4 6. 9.4
7. 9.3 7. 9.3
js_task_runner [1] js_task_runner:
Select a JavaScript task runner. The choices are: Select a JavaScript task runner. The choices are:
1. None 1. None
2. Gulp_ 2. Gulp_
custom_bootstrap_compilation [n] custom_bootstrap_compilation:
Indicates whether the project should support Bootstrap recompilation Indicates whether the project should support Bootstrap recompilation
via the selected JavaScript task runner's task. This can be useful via the selected JavaScript task runner's task. This can be useful
for real-time Bootstrap variable alteration. for real-time Bootstrap variable alteration.
use_compressor [n] use_compressor:
Indicates whether the project should be configured to use `Django Compressor`_. Indicates whether the project should be configured to use `Django Compressor`_.
use_celery [n] use_celery:
Indicates whether the project should be configured to use Celery_. Indicates whether the project should be configured to use Celery_.
use_mailhog [n] use_mailhog:
Indicates whether the project should be configured to use MailHog_. Indicates whether the project should be configured to use MailHog_.
use_sentry [n] use_sentry:
Indicates whether the project should be configured to use Sentry_. Indicates whether the project should be configured to use Sentry_.
use_whitenoise [y] use_whitenoise:
Indicates whether the project should be configured to use WhiteNoise_. Indicates whether the project should be configured to use WhiteNoise_.
use_heroku [n] use_heroku:
Indicates whether the project should be configured so as to be deployable Indicates whether the project should be configured so as to be deployable
to Heroku_. to Heroku_.
use_travisci [n] use_travisci:
Indicates whether the project should be configured to use `Travis CI`_. Indicates whether the project should be configured to use `Travis CI`_.
keep_local_envs_in_vcs [y] keep_local_envs_in_vcs:
Indicates whether the project's ``.envs/.local/`` should be kept in VCS Indicates whether the project's ``.envs/.local/`` should be kept in VCS
(comes in handy when working in teams where local environment reproducibility (comes in handy when working in teams where local environment reproducibility
is strongly encouraged). is strongly encouraged).
debug [n] debug:
Indicates whether the project should be configured for debugging. Indicates whether the project should be configured for debugging.
This option is relevant for Cookiecutter Django developers only. This option is relevant for Cookiecutter Django developers only.