18 Commits

Author SHA1 Message Date
Nathan Simpson
9b0f2b6956
docs: Document behavior of generating destination path when copying (#1498)
* Document behavior of generating destination path when copying

* Update README.md

Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>

* Update docs/generating.md

Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>

* fix: run linting

* Apply suggestions from code review

* Apply suggestions from code review

---------

Co-authored-by: Nathan Simpson <nsimpson@455-g7hgqf4ykt.cust.communityfibre.co.uk>
Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2025-03-09 20:02:05 +00:00
Sigurd Spieckermann
a75066e34c docs: use autorefs for section references 2023-08-05 20:33:57 +02:00
Sigurd Spieckermann
1031601332 docs: use relative path to Markdown file for page linking 2023-07-19 13:48:49 +02:00
Jairo Llopis
0c5a6ca2b4
docs: clarify how to use recopy to recover from broken updates
Docs were a bit repetitive and unclear.

Targets https://github.com/copier-org/copier/issues/1170. It could even fix it?

Co-authored-by: Timothée Mazzucotelli <pawamoy@pm.me>
Co-authored-by: Sigurd Spieckermann <2206639+sisp@users.noreply.github.com>
2023-07-08 10:53:14 +02:00
Sigurd Spieckermann
1b351bc856 docs: update CLI usage examples to conform with v8
All CLI calls must use a subcommand as the first argument and all flags
must come after the subcommand. See #1143.
2023-06-15 17:17:05 +01:00
Sigurd Spieckermann
e829bb5d2d docs: replace run_auto() by run_copy() 2023-05-18 11:30:12 +01:00
Jairo Llopis
e34bcda48b fix: include dirty local changes when copying HEAD
This was the intended and documented behavior, but at some point it got broken.

Well, now it's tested and it works.

Besides, there's a new FAQ to avoid further surprises.

Fixes https://github.com/copier-org/copier/issues/787
2023-04-07 11:55:59 +01:00
Sigurd Spieckermann
a230e4f4d6
docs: add advice on detecting Git repos (#1046) 2023-04-06 06:42:52 +01:00
Tomasz Pluskiewicz
8b43355889 clarify the --vcs-ref HEAD usage
closes #787
2022-09-15 17:11:41 +01:00
Sigurd Spieckermann
e682269cd5 docs: unify shell code blocks 2022-09-09 16:05:20 +01:00
Sigurd Spieckermann
e43f5855c4 docs: add missing language to code fences 2022-09-08 18:38:42 +01:00
Sigurd Spieckermann
fc6bb03a6d docs: fix spelling 2022-08-26 09:47:49 +01:00
Can Kutlu Kınay
ef11f05a98 docs: add missing link to PEP-440 2022-07-27 14:45:46 +01:00
Andrew Leech
c7d0402091 docs/generating: Add details about template version usage. 2022-02-26 08:44:36 +00:00
Jairo Llopis
2fe3072d6d docs: migration strategies across major copier versions
Try to answer a good question: when you upgrade one subproject from template v1 to v2, the template itself needs to be properly rendered in v1 to be compared to the subproject and extract the diff... well, we all know this at this point. But if Copier 6 renders differently the template v1 as compared to how Copier 5 would, then the template developer is on big trouble: How to evolve a subproject from a Copier v5-only template to a Copier v6-only template?

Fix https://github.com/copier-org/copier/issues/348
2021-07-17 08:37:30 +01:00
Jairo Llopis
2a944bf736 docs: update with latest changes
🤦‍♂️ it seems I forgot to document a lot of changes.
2021-04-20 07:21:36 +01:00
Jairo Llopis
cdb563a96d Add 4-space indentation to .md files
Mkdocs uses `python-markdown`, and [they say](https://python-markdown.github.io/#differences):

> The syntax rules clearly state that when a list item consists of multiple paragraphs, “each subsequent paragraph in a list item must be indented by either 4 spaces or one tab” (emphasis added). However, many implementations do not enforce this rule and allow less than 4 spaces of indentation. The implementers of Python-Markdown consider it a bug to not enforce this rule.

As we were using 2 spaces for markdown files (which looks better in source code), some indented lists were not displaying properly in the docs page.

Thus I change the setting to 4 spaces. Prettier will now enforce them, and mkdocs will display things properly.
2020-08-10 12:59:07 +00:00
Timothée Mazzucotelli
3ad2c67a20 Autodoc 2020-07-31 15:02:58 +02:00