Merge pull request #11 from python-project-templates/tkp/darkcode

Update instructions for action, add yardang's config to the docs

Author: timkpaine

README.md

@@ -11,6 +11,22 @@
 
 [`yardang`](https://www.britannica.com/science/yardang) makes building [Sphinx](https://www.sphinx-doc.org/en/master/) easy.
 
+## Configuration
+
+Here is `yardang`'s own configuration, in `pyproject.toml`
+
+```toml
+[tool.yardang]
+root = "docs/src/home.md"
+cname = "yardang.python-templates.dev"
+pages = [
+    "docs/src/overview.md",
+    "docs/src/installation.md",
+    "docs/src/configuration.md",
+]
+use-autoapi = true
+```
+
 ## Installation
 You can install from PyPI via `pip`:
 

docs/src/configuration.md

@@ -3,6 +3,19 @@
 Configuration for `yardang` is driven from the `pyproject.toml`, either via standard sections like `project` or from the dedicated `tool.yardang` section.
 Each option below corresponds to the [Sphinx configuration](https://www.sphinx-doc.org/en/master/usage/configuration.html).
 
+Here is `yardang`'s own configuration, in `pyproject.toml`
+
+```toml
+[tool.yardang]
+root = "docs/src/home.md"
+cname = "yardang.python-templates.dev"
+pages = [
+    "docs/src/overview.md",
+    "docs/src/installation.md",
+    "docs/src/configuration.md",
+]
+use-autoapi = true
+```
 ## [`name`](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-project)
 
 The project name is taken from the standard section, or from the `cwd`.

docs/src/overview.md

@@ -42,7 +42,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
       - run: pip install .
       - run: pip install yardang
       - run: yardang build