copier.yaml

_jinja_extensions:
  - jinja2_time.TimeExtension

# Template lives in
_subdirectory: template

# questions
project_name:
  type: str
  default: My Documentation
  help: The name for humans. Like 'My Documentation'.

project_slug:
  type: str
  default: "{{ project_name|lower|replace(' ', '-') }}"
  help: The name for machines. Like 'my_documentation'. Must be a valid folder name. We recommend do not use spaces, special characters, etc. Like 'my-documentation'."

project_author: John Doe

project_version: 0.1.0

license:
  type: str
  help: The license for the project. Like 'MIT'. Simple and permissive open-source license is 'MIT'. If none of above, choose 'Other' and replace in 'LICENSE' file.
  default: MIT
  choices:
    - MIT
    - BSD-3-Clause
    - GPL-3.0
    - Other

html_baseurl:
  type: str
  help: The address which visitors will use to reach the HTML documentation after publishing. Used for canonical link relations, and sitemap generation. Like 'https://documatt.com' or 'https://docs.documatt.com'.
  validator: "{% if not html_baseurl %}Value cannot be empty{% elif html_baseurl.endswith('/') %}MUST NOT END with trailing slash, like 'https://documatt.com/'{% endif %}"
  default: https://documatt.com

html_theme:
  help: The theme to use for HTML output. Like 'alabaster'.
  choices:
    - alabaster
  default: alabaster

default_language:
  default: en
  help: The main language of your documentation. Like 'en'.
  validator: "{% if not default_language %}Value cannot be empty{% endif %}"

other_languages:
  default: []
  help: If you want to translate your documentation to other languages, type them here or type '[]' (an empty list). The value must by a valid Python list expression like ['es', 'fr', 'de'].",
  validator: "{% if not other_languages is sequence %}Value must be a valid Python list{% elif default_language in other_languages %}The default language '{{ default_language }}' CANNOT be in other languages.{% endif %}"

default_builder:
  help: The main output format of your documentation. Enter the valid Sphinx builder like 'html'.
  default: html
  choices:
    - html
    - dirhtml
    - singlehtml

other_builders:
  default: []
  help: "If you want to build your documentation to other formats, choose additional builders here. "
  choices:
    - html
    - dirhtml
    - singlehtml
  multiselect: true
  validator: "{% if default_builder in other_builders %}The default builder '{{ default_builder }}' CANNOT be in other builders.{% endif %}"