feat: initial copier

Author: liborjelinek

.github/workflows/test.yaml

@@ -0,0 +1,18 @@
+name: Tests
+
+on:
+  push:
+    # on all branches
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Set up Python
+        run: uv python install
+      - name: Run tests
+        run: uv run pytest

.gitignore

@@ -3,7 +3,11 @@
 venv/
 .nox
 __pycache__
+*.py[oc]
 *.egg-info/
+.pytest_cache/
+dist/
+wheels/
 
 # Sphinx
 build
@@ -19,4 +23,4 @@ node_modules
 # editors
 .idea/
 !.vscode/*.sample
-.vscode/*
+.vscode/*

.prettierignore

@@ -0,0 +1 @@
+# Everything from .gitignore ignored by Prettier too

.python-version

@@ -0,0 +1 @@
+3.11

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Initial version.

README.md

@@ -0,0 +1,86 @@
+<div align="center">
+
+<a href="https://documatt.com/sphinx-docs-template">
+    <img src="https://github.com/documatt/sphinx-docs-template/blob/main/hero.png?raw=true" alt="Project hero image">
+</a>
+
+<h1>Sphinx Documentation Template</h1>
+
+<p><strong>An opinionated template for creating a modern Sphinx documentation project. Write in Markdown or reStructuredText, translate to multiple languages, boost with popular extensions, and enjoy automatic live reload on change.</strong></p>
+
+<p>Default blank Sphinx documentation project needs a lot of configuration, fine-tuning, trials, and fails before setting up everything for best results. This template results from the best practices and knowledge we gained by providing <a href="https://documatt.com/services">Documatt's technical writing services</a>.</p>
+
+<p>
+    <a href="https://documatt.com/sphinx-docs-template">📚Documentation</a> ·
+    <a href="https://github.com/documatt/sphinx-docs-template">📟 Source code</a>
+</p>
+
+<p>
+    <a href="https://github.com/copier-org/copier"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json&labelColor=097cba&color=163B36" alt="Made with Copier badge"/></a>
+    <a href="https://github.com/documatt/sphinx-docs-template">
+        <img src="https://img.shields.io/github/stars/documatt/sphinx-docs-template?style=flat&logo=github&labelColor=097cba&color=163B36" alt="GitHub Repo stars badge">
+    </a>
+    <a href="https://github.com/documatt/sphinx-docs-template/actions/workflows/test.yaml">
+        <img src="https://github.com/documatt/sphinx-docs-template/actions/workflows/test.yaml/badge.svg" alt="GitHub tests badge">
+    </a>
+    <img src="https://img.shields.io/badge/codestyle-Prettier-blue?labelColor=097cba&color=163B36" alt="Code style Prettier badge">
+    <a href="https://raw.githubusercontent.com/documatt/sphinx-docs-template/refs/heads/main/LICENSE">
+        <img src="https://img.shields.io/badge/license-MIT-blue?labelColor=097cba&color=163B36" alt="MIT licence badge">
+    </a>
+</p>
+
+</div>
+
+<!-- Very short intro -->
+
+The repository is the Copier template. Copier is a command-line tool for creating projects from templates. It requires Python installed, but no knowledge of Python to use.
+
+To use the template, [install Copier](https://www.cookiecutter.io) first and then run the following command in your terminal:
+
+```
+cookiecutter https://github.com/documatt/sphinx-docs-template
+```
+
+Answer the series of questions, and you are ready to go. You have the skeleton of a completely functional Sphinx project in just a few moments.
+
+<!-- TODO: Screenshot / video -->
+<div align="center">
+<img alt="Quickstart" src="https://raw.githubusercontent.com/cruft/cruft/master/art/example.gif">
+</div>
+
+## Key Features
+
+The Sphinx documentation template creates supports:
+
+- 💯 Free & open-source.
+- ✍️ Write in Markdown or reStructuredText.
+- 🏗️ Comes with popular Sphinx extension for sitemaps, redirects, diagrams, etc.
+- 👅 Localization (i18n) support.
+- 😀 Sane configuration defaults and best practices.
+- 🎨 Format on save in VS Code.
+- ⚒️ Live reload on change.
+- 💾 Build to multiple outputs.
+- 👍 Works out-of-the-box.
+
+Learn more in [📚documentation](https://documatt.com/sphinx-docs-template).
+
+## Community and contributions
+
+Bug repors, feature requests, or all contributions are welcome at our [GitHub homepage](https://github.com/documatt/sphinx-docs-template/).
+
+Connect with other fellows who are building with Sphinx. Share knowledge, get help, and contribute to the open-source project. Check out our [Documatt Community](https://documatt.com/community) page to see featured material and upcoming events.
+
+Join our community here:
+
+- 🌟 [Explore our GitHub](https://github.com/documatt)
+- 📥 [Subscribe to our newsletter](https://documatt.com/newsletter-signup/)
+- 🐦 [Follow us on X](https://x.com/documattcom)
+- 🕴️ [Follow us on LinkedIn](https://www.linkedin.com/company/documattcom)
+- 📺 [Subscribe to our YouTube channel](https://www.youtube.com/@Documatt)
+- 📚 [Read our blog posts](https://documatt.com/blog)
+
+## Legal
+
+Project is is MIT licensed.
+
+Icon "copy" by [TabletIcons](https://tablericons.com/icon/copy).

copier.yaml

@@ -0,0 +1,70 @@
+_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 langauges, 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 %}"