Standardise YAML file extension from .yml to .yaml

Author: dannyadair

.github/workflows/pre-commit.yml .github/workflows/pre-commit.yaml.github/workflows/pre-commit.yml renamed to .github/workflows/pre-commit.yaml

@@ -4,14 +4,14 @@
 
 ```
 project/
-├── kiwipycon.yml         # Main configuration
+├── kiwipycon.yaml        # Main configuration
 ├── material_specs/       # A document
-│   ├── config.yml        # Document configuration
+│   ├── config.yaml       # Document configuration
 │   ├── images/           # Images
 │   ├── pages/            # Page configurations
 │   └── templates/        # SVG templates
 └── prospectus/           # Another document
-    ├── config.yml
+    ├── config.yaml
     ├── images/
     ├── pages/
     └── templates/
@@ -21,7 +21,7 @@ project/
 
 | Option            | Type    | Default      | Description                                                                                                        |
 | ----------------- | ------- | ------------ | ------------------------------------------------------------------------------------------------------------------ |
-| `documents`       | array   | Yes          | List of document directories. Each directory must contain a `config.yml` file                                      |
+| `documents`       | array   | Yes          | List of document directories. Each directory must contain a `config.yaml` file                                     |
 | `style`           | object  | No           | Global style definitions that may reference `theme` values                                                         |
 | `theme`           | object  | No           | Reusable values (colors, fonts, spacing, etc.) used by `style`                                                     |
 | `compress_pdf`    | boolean | `false`      | Whether to compress the final PDF. Requires Ghostscript.                                                           |
@@ -33,7 +33,7 @@ highlighted in the color specified by the `highlight_color` in your `style`.
 Example:
 
 ```yaml
-# kiwipycon.yml
+# kiwipycon.yaml
 
 documents:
   - prospectus
@@ -74,13 +74,13 @@ for each document.
 | Option     | Type   | Required | Description                                                                                                                     |
 | ---------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
 | `filename` | string | Yes      | Filename (without extension) of the final PDF document. Can use variables, particularly `variant` (see [Variants](variants.md)) |
-| `pages`    | array  | Yes      | List of page names. Each page must have a corresponding `.yml` file in the `pages/` directory                                   |
+| `pages`    | array  | Yes      | List of page names. Each page must have a corresponding `.yaml` file in the `pages/` directory                                  |
 | `variants` | array  | No       | List of document variants (see [Variants](variants.md))                                                                         |
 
 Example:
 
 ```yaml
-# prospectus/config.yml
+# prospectus/config.yaml
 
 filename: "Kiwi PyCon {{ conference.year }} - Prospectus" # Use config values in config values!
 title: "Sponsorship Prospectus"
@@ -105,7 +105,7 @@ merged with this for access to all settings in your template.
 Example:
 
 ```yaml
-# pages/conference_schedule.yml
+# pages/conference_schedule.yaml
 
 template: list_section.svg.j2
 

docs/configuration.md

@@ -17,7 +17,7 @@ from pdfbaker.document import PDFBakerDocument
 
 def process_document(document: PDFBakerDocument) -> None:
     # Custom processing logic here
-    return document.process()
+    document.process()
 ```
 
 You will usually just manipulate the data for your templates, and then call `.process()`
@@ -27,5 +27,5 @@ the PDF as configured.
 See `examples/custom_processing/bake.py` for a simple example of how to do this.
 
 If you need to fully customise the processing, make sure that your function returns a
-list of Path objects (the PDF files that were created) as that is the expected type of
-return value for logging.
+Path or list of Path objects (the PDF files that were created) as that is the expected
+type of return value for logging.

docs/custom_processing.md

@@ -25,25 +25,26 @@ For a quick introduction, see the [README](../README.md).
 
 ## Examples
 
-See the [examples](../examples) directory for simple working examples:
+See the [examples](examples) directory:
 
-- [minimal](../examples/minimal) - Basic single page
-- [regular](../examples/regular) - Using various features
-- [variants](../examples/variants) - Different PDFs of the same document
-- [custom_processing](../examples/custom_processing) - Custom Python code
+- [minimal](examples/minimal) - Basic usage
+- [regular](examples/regular) - Standard features
+- [variants](examples/variants) - Document variants
+- [custom_locations](examples/custom_locations) - Custom file/directory locations
+- [custom_processing](examples/custom_processing) - Custom processing with Python
 
 ## Example Project Structure
 
 ```
 project/
-├── kiwipycon.yml         # Main configuration
+├── kiwipycon.yaml        # Main configuration
 ├── material_specs/       # A document
-│   ├── config.yml        # Document configuration
+│   ├── config.yaml       # Document configuration
 │   ├── images/           # Images
 │   ├── pages/            # Page configurations
 │   └── templates/        # SVG templates
 └── prospectus/           # Another document
-    ├── config.yml
+    ├── config.yaml
     ├── images/
     ├── pages/
     └── templates/

docs/overview.md

@@ -10,7 +10,7 @@ different content or settings. This is useful for:
 
 ## Basic Structure
 
-Variants are defined in your document's `config.yml`:
+Variants are defined in your document's `config.yaml`:
 
 ```yaml
 filename: "My Document - {{ variant.name }}"

docs/variants.md

@@ -2,4 +2,5 @@ documents:
   - minimal
   - regular
   - variants
+  - "./custom_locations/your_directory"
   - custom_processing

examples/custom_processing/config.yml examples/custom_processing/config.yamlexamples/custom_processing/config.yml renamed to examples/custom_processing/config.yaml

@@ -1,3 +1,4 @@
+template: main.svg.j2
 filename: minimal_example
 pages:
   - main