- Workaround mkdocstrings/pytkdocs#86

Author: yajo

copier/template.py

@@ -112,7 +112,10 @@ class Template:
 
     @cached_property
     def _raw_config(self) -> AnyByStrDict:
-        """Get template configuration, raw."""
+        """Get template configuration, raw.
+
+        It reads [the `copier.yml` file][the-copieryml-file].
+        """
         result = load_config_data(self.local_abspath)
         with suppress(KeyError):
             verify_minimum_version(result["_min_copier_version"])
@@ -123,6 +126,8 @@ def answers_relpath(self) -> Path:
         """Get the answers file relative path, as specified in the template.
 
         If not specified, returns the default `.copier-answers.yml`.
+
+        See [answers_file][].
         """
         result = Path(self.config_data.get("answers_file", ".copier-answers.yml"))
         assert not result.is_absolute()
@@ -137,7 +142,11 @@ def commit(self) -> OptStr:
 
     @cached_property
     def config_data(self) -> AnyByStrDict:
-        """Get config from the template."""
+        """Get config from the template.
+
+        It reads [the `copier.yml` file][the-copieryml-file] to get its
+        [settings][available-settings].
+        """
         return filter_config(self._raw_config)[0]
 
     @cached_property
@@ -147,7 +156,10 @@ def default_answers(self) -> AnyByStrDict:
 
     @cached_property
     def envops(self) -> Mapping:
-        """Get the Jinja configuration specified in the template, or default values."""
+        """Get the Jinja configuration specified in the template, or default values.
+
+        See [envops][].
+        """
         # TODO Use Jinja defaults
         result = {
             "autoescape": False,
@@ -164,7 +176,10 @@ def envops(self) -> Mapping:
 
     @cached_property
     def exclude(self) -> Tuple[str, ...]:
-        """Get exclusions specified in the template, or default ones."""
+        """Get exclusions specified in the template, or default ones.
+
+        See [exclude][].
+        """
         return tuple(self.config_data.get("exclude", DEFAULT_EXCLUDE))
 
     @cached_property
@@ -183,6 +198,8 @@ def migration_tasks(self, stage: str, from_: str, to: str) -> Sequence[Mapping]:
         """Get migration objects that match current version spec.
 
         Versions are compared using PEP 440.
+
+        See [migrations][].
         """
         result: List[dict] = []
         if not from_ or not to:
@@ -206,7 +223,10 @@ def migration_tasks(self, stage: str, from_: str, to: str) -> Sequence[Mapping]:
 
     @cached_property
     def questions_data(self) -> AnyByStrDict:
-        """Get questions from the template."""
+        """Get questions from the template.
+
+        See [questions][].
+        """
         return filter_config(self._raw_config)[1]
 
     @cached_property
@@ -226,6 +246,8 @@ def skip_if_exists(self) -> StrSeq:
         """Get skip patterns from the template.
 
         These files will never be rewritten when rendering the template.
+
+        See [skip_if_exists][].
         """
         return self.config_data.get("skip_if_exists", ())
 
@@ -236,19 +258,26 @@ def subdirectory(self) -> str:
         The subdirectory points to the real template code, allowing the
         templater to separate it from other template assets, such as docs,
         tests, etc.
+
+        See [subdirectory][].
         """
         return self.config_data.get("subdirectory", "")
 
     @cached_property
     def tasks(self) -> Sequence:
-        """Get tasks defined in the template."""
+        """Get tasks defined in the template.
+
+        See [tasks][].
+        """
         return self.config_data.get("tasks", [])
 
     @cached_property
     def templates_suffix(self) -> str:
         """Get the suffix defined for templates.
 
         By default: `.tmpl`.
+
+        See [templates_suffix][].
         """
         return self.config_data.get("templates_suffix", DEFAULT_TEMPLATES_SUFFIX)
 

docs/configuring.md

@@ -290,6 +290,32 @@ is overriden, and don't ask user anything else:
 copier -fd 'user_name=Manuel Calavera' copy template destination
 ```
 
+### `envops`
+
+-   Format: `dict`
+-   CLI flags: N/A
+-   Default value:
+
+    ```yaml
+    {
+        "autoescape": False,
+        "block_end_string": "%]",
+        "block_start_string": "[%",
+        "comment_end_string": "#]",
+        "comment_start_string": "[#",
+        "keep_trailing_newline": True,
+        "variable_end_string": "]]",
+        "variable_start_string": "[[",
+    }
+    ```
+
+Configurations for the Jinja environment.
+
+These defaults are different from upstream Jinja's.
+
+See [upstream docs](https://jinja.palletsprojects.com/en/2.11.x/api/#jinja2.Environment)
+to know available options.
+
 ### `exclude`
 
 -   Format: `List[str]`

poetry.lock

@@ -44,6 +44,7 @@ pyyaml = "^5.3.1"
 pyyaml-include = "^1.2"
 questionary = "^1.8.1"
 typing-extensions = {version = "^3.7.4", python = "<3.8"}
+# HACK https://github.com/pawamoy/pytkdocs/issues/86
 # HACK https://github.com/pawamoy/mkdocstrings/issues/225#issuecomment-774669999
 pytkdocs = {git = "https://github.com/pawamoy/pytkdocs.git", rev = "master", optional = true}