Only put container docs in if publishing them (#114)

Author: coretl

template/README.md.jinja

@@ -13,7 +13,8 @@ how it does it, and why people should use it.
 Source          | <{{repo_url}}>
 :---:           | :---:
 PyPI            | `pip install {{distribution_name}}`
-{% if sphinx %}Documentation   | <{{docs_url}}>{% endif %}
+{% if docker %}Docker          | `docker run ghcr.io/{{github_org | lower}}/{{repo_name}}:latest`
+{% endif %}{% if sphinx %}Documentation   | <{{docs_url}}>{% endif %}
 Releases        | <{{repo_url}}/releases>
 
 This is where you should put some images or code snippets that illustrate

…% endif %}/how-to/run-container.md.jinja …cker %}run-container.md{% endif %}.jinjatemplate/{% if sphinx %}docs{% endif %}/how-to/run-container.md.jinja renamed to template/{% if sphinx %}docs{% endif %}/how-to/{% if docker %}run-container.md{% endif %}.jinja template/{% if sphinx %}docs{% endif %}/how-to/run-container.md.jinja renamed to template/{% if sphinx %}docs{% endif %}/how-to/{% if docker %}run-container.md{% endif %}.jinja

@@ -8,7 +8,7 @@ installed are available on [Github Container Registry](https://ghcr.io/{{github_
 To pull the container from github container registry and run:
 
 ```
-$ docker run ghcr.io/{{github_org}}/{{repo_name}}:main --version
+$ docker run ghcr.io/{{github_org | lower}}/{{repo_name}}:latest --version
 ```
 
-To get a released version, use a numbered release instead of `main`.
+To get a released version, use a numbered release instead of `latest`.

tests/test_example.py

@@ -47,6 +47,8 @@ def make_venv(project_path: Path) -> callable:
 def test_template(tmp_path: Path):
     copy_project(tmp_path)
     run = make_venv(tmp_path)
+    container_doc = tmp_path / "docs" / "how-to" / "run-container.md"
+    assert container_doc.exists()
     run("./venv/bin/tox -p")
     run("./venv/bin/pip install build twine")
     run("./venv/bin/python -m build")
@@ -59,6 +61,12 @@ def test_template_no_docs(tmp_path: Path):
     run("./venv/bin/tox -p")
 
 
+def test_template_no_docker_has_no_docs(tmp_path: Path):
+    copy_project(tmp_path, docker=False)
+    container_doc = tmp_path / "docs" / "how-to" / "run-container.md"
+    assert not container_doc.exists()
+
+
 def test_bad_repo_name(tmp_path: Path):
     with pytest.raises(ValidationError, match="bad:thing is not a valid repo name"):
         copy_project(tmp_path, repo_name="bad:thing")