Bump actions/checkout from 5 to 6

Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

.github/dependabot.yml

@@ -4,6 +4,10 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      all:
+        patterns:
+          - "*"
 
   - package-ecosystem: "github-actions"
     directory: "/"

.github/workflows/python-package.yaml

@@ -1,12 +1,9 @@
-name: CI/CD Pipeline
-
 on:
   - push
   - pull_request
 
 jobs:
   test:
-    name: Test Python ${{ matrix.python-version }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
 
     strategy:
@@ -17,19 +14,15 @@ jobs:
           - macos-latest
           - windows-latest
         python-version:
-          - "3.8"
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
-        exclude:
+          - "3.13"
-          # 3.8 on windows fails due to some pip issue
+          - "3.14"
-          - os: windows-latest
-            python-version: "3.8"
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -42,8 +35,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v6
       with:
         python-version: "3.x"
 
@@ -56,8 +49,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v6
       with:
         python-version: "3.x"
 
@@ -71,8 +64,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v6
       with:
         python-version: "3.x"
 

.readthedocs.yaml

@@ -3,13 +3,13 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.12"
 
 mkdocs:
   configuration: mkdocs.yml
 
 python:
   install:
-  - requirements: requirements.txt
-  - requirements: requirements-dev.txt
     - path: .
+      extra_requirements:
+        - dev

CHANGELOG.md

@@ -1,5 +1,44 @@
 # Changelog
 
+## [unreleased] --
+
+* Added Python 3.14 compatibility
+* Removed requirements.txt and requirements-dev.txt
+* Added footnotes extension for markdown
+
+## [2.3.3] -- 2025-04-27
+
+* Fixed Atom feed encoding to 'utf-8'
+* Added Python 3.13 to github actions
+* `requirements*.txt` files are handled by pip-tools. Updates are handled by
+  make update-requirements based on the dependencies described in the
+  pyproject.toml
+
+## [2.3.2] -- 2024-10-13
+
+* Ignore FileNotFoundError when trying to get the last modified time of files
+  in directories. This happens for example with temporary emacs files.
+* Added changelog to docs
+* removed ruff's target-version from pyproject.toml, this value defaults to the
+  projects requires-python
+
+## [2.3.1] -- 2024-07-06
+
+* added manpage
+* added makefile target for generating blog's manpage
+* added makefile target for serving blags docs locally
+* mkdocs: disabled loading of google fonts, using locally installed system
+  fonts instead
+* Debian: simplified html docs directory for blag-doc package
+* Debian: changed section from Python to Web
+* updated dependencies
+
+## [2.3.0] -- 2024-04-24
+
+* fixed devsever so it does not crash anymore when the (re-)build fails
+* dropped support for Python 3.8 and 3.9
+* updated dependencies
+
 ## [2.2.1] -- 2023-11-11
 
 * fixed `suggests` to blag-doc

Makefile

@@ -16,11 +16,9 @@ endif
 .PHONY: all
 all: lint mypy test test-release
 
-$(VENV): requirements.txt requirements-dev.txt pyproject.toml
+$(VENV): pyproject.toml
 	$(PY) -m venv $(VENV)
-	$(BIN)/pip install --upgrade -r requirements.txt
+	$(BIN)/pip install --upgrade -e .['dev']
-	$(BIN)/pip install --upgrade -r requirements-dev.txt
-	$(BIN)/pip install -e .['dev']
 	touch $(VENV)
 
 .PHONY: test
@@ -57,6 +55,14 @@ update-pygmentize: $(VENV)
 docs: $(VENV)
 	$(BIN)/mkdocs build
 
+.PHONY: serve-docs
+serve-docs: $(VENV)
+	$(BIN)/mkdocs serve
+
+.PHONY: manpage
+manpage: $(VENV)
+	help2man $(BIN)/blag --no-info -n "blog-aware, static site generator" -o debian/blag.1
+
 .PHONY: clean
 clean:
 	rm -rf build dist *.egg-info

README.md

@@ -21,10 +21,11 @@ blag is named after [the blag of the webcomic xkcd][blagxkcd].
 * Theming support using [Jinja2][] templates
 * Generation of Atom feeds for blog content
 * Fenced code blocks and syntax highlighting using [Pygments][]
+* Markdown footnotes
 * Integrated devserver
 * Available on [PyPI][]
 
-blag runs on Linux, Mac and Windows and requires Python >= 3.8
+blag runs on Linux, Mac and Windows and requires Python >= 3.10
 
 [markdown]: https://daringfireball.net/projects/markdown/
 [jinja2]: https://palletsprojects.com/p/jinja/

blag/blag.py

@@ -2,9 +2,6 @@
 
 """blag's core methods."""
 
-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import argparse
 import configparser
 import logging
@@ -399,7 +396,7 @@ def generate_feed(
         )
 
     with open(f"{output_dir}/atom.xml", "w") as fh:
-        feed.write(fh, encoding="utf8")
+        feed.write(fh, encoding='utf-8')
 
 
 def generate_index(

blag/devserver.py

@@ -6,9 +6,6 @@ site if necessary.
 
 """
 
-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import argparse
 import logging
 import multiprocessing
@@ -45,14 +42,19 @@ def get_last_modified(dirs: list[str]) -> float:
     for dir in dirs:
         for root, dirs, files in os.walk(dir):
             for f in files:
+                try:
                     mtime = os.stat(os.path.join(root, f)).st_mtime
+                except FileNotFoundError:
+                    # ignore files that have been deleted since the os.walk
+                    # call (for example temporary emacs files)
+                    continue
                 if mtime > last_mtime:
                     last_mtime = mtime
 
     return last_mtime
 
 
-def autoreload(args: argparse.Namespace) -> NoReturn:
+def autoreload(args: argparse.Namespace, wait: int=1) -> NoReturn:
     """Start the autoreloader.
 
     This method monitors the given directories for changes (i.e. the
@@ -66,6 +68,9 @@ def autoreload(args: argparse.Namespace) -> NoReturn:
     ----------
     args
         contains the input-, template- and static dir
+    wait
+        number of seconds the devsever waits before checking for updated
+        content
 
     """
     dirs = [args.input_dir, args.template_dir, args.static_dir]
@@ -74,12 +79,18 @@ def autoreload(args: argparse.Namespace) -> NoReturn:
     # loop to avoid serving stale contents
     last_mtime = 0.0
     while True:
+        # make sure the devsever does not crash when the build fails with an
+        # exception
+        try:
             mtime = get_last_modified(dirs)
             if mtime > last_mtime:
                 last_mtime = mtime
                 logger.info("Change detected, rebuilding...")
                 blag.build(args)
-        time.sleep(1)
+            time.sleep(wait)
+        except Exception:
+            logger.exception("Error occurred during rebuild:")
+            logger.info("Devserver did not crash, you may continue editing.")
 
 
 def serve(args: argparse.Namespace) -> None:

blag/markdown.py

@@ -5,9 +5,6 @@ processing.
 
 """
 
-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import logging
 from datetime import datetime
 from urllib.parse import urlsplit, urlunsplit
@@ -37,6 +34,7 @@ def markdown_factory() -> Markdown:
             "fenced_code",
             "codehilite",
             "smarty",
+            "footnotes",
             MarkdownLinkExtension(),
         ],
         output_format="html",

blag/quickstart.py

@@ -1,8 +1,5 @@
 """Helper methods for blag's quickstart command."""
 
-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import argparse
 import configparser
 import os

blag/static/code-dark.css

@@ -4,80 +4,81 @@ span.linenos { color: inherit; background-color: transparent; padding-left: 5px;
 td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .hll { background-color: #49483e }
-.c { color: #75715e } /* Comment */
+.c { color: #959077 } /* Comment */
-.err { color: #960050; background-color: #1e0010 } /* Error */
+.err { color: #ED007E; background-color: #1E0010 } /* Error */
-.esc { color: #f8f8f2 } /* Escape */
+.esc { color: #F8F8F2 } /* Escape */
-.g { color: #f8f8f2 } /* Generic */
+.g { color: #F8F8F2 } /* Generic */
-.k { color: #66d9ef } /* Keyword */
+.k { color: #66D9EF } /* Keyword */
-.l { color: #ae81ff } /* Literal */
+.l { color: #AE81FF } /* Literal */
-.n { color: #f8f8f2 } /* Name */
+.n { color: #F8F8F2 } /* Name */
-.o { color: #f92672 } /* Operator */
+.o { color: #FF4689 } /* Operator */
-.x { color: #f8f8f2 } /* Other */
+.x { color: #F8F8F2 } /* Other */
-.p { color: #f8f8f2 } /* Punctuation */
+.p { color: #F8F8F2 } /* Punctuation */
-.ch { color: #75715e } /* Comment.Hashbang */
+.ch { color: #959077 } /* Comment.Hashbang */
-.cm { color: #75715e } /* Comment.Multiline */
+.cm { color: #959077 } /* Comment.Multiline */
-.cp { color: #75715e } /* Comment.Preproc */
+.cp { color: #959077 } /* Comment.Preproc */
-.cpf { color: #75715e } /* Comment.PreprocFile */
+.cpf { color: #959077 } /* Comment.PreprocFile */
-.c1 { color: #75715e } /* Comment.Single */
+.c1 { color: #959077 } /* Comment.Single */
-.cs { color: #75715e } /* Comment.Special */
+.cs { color: #959077 } /* Comment.Special */
-.gd { color: #f92672 } /* Generic.Deleted */
+.gd { color: #FF4689 } /* Generic.Deleted */
-.ge { color: #f8f8f2; font-style: italic } /* Generic.Emph */
+.ge { color: #F8F8F2; font-style: italic } /* Generic.Emph */
-.gr { color: #f8f8f2 } /* Generic.Error */
+.ges { color: #F8F8F2; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
-.gh { color: #f8f8f2 } /* Generic.Heading */
+.gr { color: #F8F8F2 } /* Generic.Error */
-.gi { color: #a6e22e } /* Generic.Inserted */
+.gh { color: #F8F8F2 } /* Generic.Heading */
-.go { color: #66d9ef } /* Generic.Output */
+.gi { color: #A6E22E } /* Generic.Inserted */
-.gp { color: #f92672; font-weight: bold } /* Generic.Prompt */
+.go { color: #66D9EF } /* Generic.Output */
-.gs { color: #f8f8f2; font-weight: bold } /* Generic.Strong */
+.gp { color: #FF4689; font-weight: bold } /* Generic.Prompt */
-.gu { color: #75715e } /* Generic.Subheading */
+.gs { color: #F8F8F2; font-weight: bold } /* Generic.Strong */
-.gt { color: #f8f8f2 } /* Generic.Traceback */
+.gu { color: #959077 } /* Generic.Subheading */
-.kc { color: #66d9ef } /* Keyword.Constant */
+.gt { color: #F8F8F2 } /* Generic.Traceback */
-.kd { color: #66d9ef } /* Keyword.Declaration */
+.kc { color: #66D9EF } /* Keyword.Constant */
-.kn { color: #f92672 } /* Keyword.Namespace */
+.kd { color: #66D9EF } /* Keyword.Declaration */
-.kp { color: #66d9ef } /* Keyword.Pseudo */
+.kn { color: #FF4689 } /* Keyword.Namespace */
-.kr { color: #66d9ef } /* Keyword.Reserved */
+.kp { color: #66D9EF } /* Keyword.Pseudo */
-.kt { color: #66d9ef } /* Keyword.Type */
+.kr { color: #66D9EF } /* Keyword.Reserved */
-.ld { color: #e6db74 } /* Literal.Date */
+.kt { color: #66D9EF } /* Keyword.Type */
-.m { color: #ae81ff } /* Literal.Number */
+.ld { color: #E6DB74 } /* Literal.Date */
-.s { color: #e6db74 } /* Literal.String */
+.m { color: #AE81FF } /* Literal.Number */
-.na { color: #a6e22e } /* Name.Attribute */
+.s { color: #E6DB74 } /* Literal.String */
-.nb { color: #f8f8f2 } /* Name.Builtin */
+.na { color: #A6E22E } /* Name.Attribute */
-.nc { color: #a6e22e } /* Name.Class */
+.nb { color: #F8F8F2 } /* Name.Builtin */
-.no { color: #66d9ef } /* Name.Constant */
+.nc { color: #A6E22E } /* Name.Class */
-.nd { color: #a6e22e } /* Name.Decorator */
+.no { color: #66D9EF } /* Name.Constant */
-.ni { color: #f8f8f2 } /* Name.Entity */
+.nd { color: #A6E22E } /* Name.Decorator */
-.ne { color: #a6e22e } /* Name.Exception */
+.ni { color: #F8F8F2 } /* Name.Entity */
-.nf { color: #a6e22e } /* Name.Function */
+.ne { color: #A6E22E } /* Name.Exception */
-.nl { color: #f8f8f2 } /* Name.Label */
+.nf { color: #A6E22E } /* Name.Function */
-.nn { color: #f8f8f2 } /* Name.Namespace */
+.nl { color: #F8F8F2 } /* Name.Label */
-.nx { color: #a6e22e } /* Name.Other */
+.nn { color: #F8F8F2 } /* Name.Namespace */
-.py { color: #f8f8f2 } /* Name.Property */
+.nx { color: #A6E22E } /* Name.Other */
-.nt { color: #f92672 } /* Name.Tag */
+.py { color: #F8F8F2 } /* Name.Property */
-.nv { color: #f8f8f2 } /* Name.Variable */
+.nt { color: #FF4689 } /* Name.Tag */
-.ow { color: #f92672 } /* Operator.Word */
+.nv { color: #F8F8F2 } /* Name.Variable */
-.pm { color: #f8f8f2 } /* Punctuation.Marker */
+.ow { color: #FF4689 } /* Operator.Word */
-.w { color: #f8f8f2 } /* Text.Whitespace */
+.pm { color: #F8F8F2 } /* Punctuation.Marker */
-.mb { color: #ae81ff } /* Literal.Number.Bin */
+.w { color: #F8F8F2 } /* Text.Whitespace */
-.mf { color: #ae81ff } /* Literal.Number.Float */
+.mb { color: #AE81FF } /* Literal.Number.Bin */
-.mh { color: #ae81ff } /* Literal.Number.Hex */
+.mf { color: #AE81FF } /* Literal.Number.Float */
-.mi { color: #ae81ff } /* Literal.Number.Integer */
+.mh { color: #AE81FF } /* Literal.Number.Hex */
-.mo { color: #ae81ff } /* Literal.Number.Oct */
+.mi { color: #AE81FF } /* Literal.Number.Integer */
-.sa { color: #e6db74 } /* Literal.String.Affix */
+.mo { color: #AE81FF } /* Literal.Number.Oct */
-.sb { color: #e6db74 } /* Literal.String.Backtick */
+.sa { color: #E6DB74 } /* Literal.String.Affix */
-.sc { color: #e6db74 } /* Literal.String.Char */
+.sb { color: #E6DB74 } /* Literal.String.Backtick */
-.dl { color: #e6db74 } /* Literal.String.Delimiter */
+.sc { color: #E6DB74 } /* Literal.String.Char */
-.sd { color: #e6db74 } /* Literal.String.Doc */
+.dl { color: #E6DB74 } /* Literal.String.Delimiter */
-.s2 { color: #e6db74 } /* Literal.String.Double */
+.sd { color: #E6DB74 } /* Literal.String.Doc */
-.se { color: #ae81ff } /* Literal.String.Escape */
+.s2 { color: #E6DB74 } /* Literal.String.Double */
-.sh { color: #e6db74 } /* Literal.String.Heredoc */
+.se { color: #AE81FF } /* Literal.String.Escape */
-.si { color: #e6db74 } /* Literal.String.Interpol */
+.sh { color: #E6DB74 } /* Literal.String.Heredoc */
-.sx { color: #e6db74 } /* Literal.String.Other */
+.si { color: #E6DB74 } /* Literal.String.Interpol */
-.sr { color: #e6db74 } /* Literal.String.Regex */
+.sx { color: #E6DB74 } /* Literal.String.Other */
-.s1 { color: #e6db74 } /* Literal.String.Single */
+.sr { color: #E6DB74 } /* Literal.String.Regex */
-.ss { color: #e6db74 } /* Literal.String.Symbol */
+.s1 { color: #E6DB74 } /* Literal.String.Single */
-.bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */
+.ss { color: #E6DB74 } /* Literal.String.Symbol */
-.fm { color: #a6e22e } /* Name.Function.Magic */
+.bp { color: #F8F8F2 } /* Name.Builtin.Pseudo */
-.vc { color: #f8f8f2 } /* Name.Variable.Class */
+.fm { color: #A6E22E } /* Name.Function.Magic */
-.vg { color: #f8f8f2 } /* Name.Variable.Global */
+.vc { color: #F8F8F2 } /* Name.Variable.Class */
-.vi { color: #f8f8f2 } /* Name.Variable.Instance */
+.vg { color: #F8F8F2 } /* Name.Variable.Global */
-.vm { color: #f8f8f2 } /* Name.Variable.Magic */
+.vi { color: #F8F8F2 } /* Name.Variable.Instance */
-.il { color: #ae81ff } /* Literal.Number.Integer.Long */
+.vm { color: #F8F8F2 } /* Name.Variable.Magic */
+.il { color: #AE81FF } /* Literal.Number.Integer.Long */

blag/static/code-light.css

@@ -5,9 +5,9 @@ td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5
 span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .hll { background-color: #ffffcc }
 .c { color: #3D7B7B; font-style: italic } /* Comment */
-.err { border: 1px solid #FF0000 } /* Error */
+.err { border: 1px solid #F00 } /* Error */
 .k { color: #008000; font-weight: bold } /* Keyword */
-.o { color: #666666 } /* Operator */
+.o { color: #666 } /* Operator */
 .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
 .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
 .cp { color: #9C6500 } /* Comment.Preproc */
@@ -16,6 +16,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
 .gd { color: #A00000 } /* Generic.Deleted */
 .ge { font-style: italic } /* Generic.Emph */
+.ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .gr { color: #E40000 } /* Generic.Error */
 .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .gi { color: #008400 } /* Generic.Inserted */
@@ -23,34 +24,34 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
 .gs { font-weight: bold } /* Generic.Strong */
 .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
-.gt { color: #0044DD } /* Generic.Traceback */
+.gt { color: #04D } /* Generic.Traceback */
 .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
 .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
 .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
 .kp { color: #008000 } /* Keyword.Pseudo */
 .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
 .kt { color: #B00040 } /* Keyword.Type */
-.m { color: #666666 } /* Literal.Number */
+.m { color: #666 } /* Literal.Number */
 .s { color: #BA2121 } /* Literal.String */
 .na { color: #687822 } /* Name.Attribute */
 .nb { color: #008000 } /* Name.Builtin */
-.nc { color: #0000FF; font-weight: bold } /* Name.Class */
+.nc { color: #00F; font-weight: bold } /* Name.Class */
-.no { color: #880000 } /* Name.Constant */
+.no { color: #800 } /* Name.Constant */
-.nd { color: #AA22FF } /* Name.Decorator */
+.nd { color: #A2F } /* Name.Decorator */
 .ni { color: #717171; font-weight: bold } /* Name.Entity */
 .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
-.nf { color: #0000FF } /* Name.Function */
+.nf { color: #00F } /* Name.Function */
 .nl { color: #767600 } /* Name.Label */
-.nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.nn { color: #00F; font-weight: bold } /* Name.Namespace */
 .nt { color: #008000; font-weight: bold } /* Name.Tag */
 .nv { color: #19177C } /* Name.Variable */
-.ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.ow { color: #A2F; font-weight: bold } /* Operator.Word */
-.w { color: #bbbbbb } /* Text.Whitespace */
+.w { color: #BBB } /* Text.Whitespace */
-.mb { color: #666666 } /* Literal.Number.Bin */
+.mb { color: #666 } /* Literal.Number.Bin */
-.mf { color: #666666 } /* Literal.Number.Float */
+.mf { color: #666 } /* Literal.Number.Float */
-.mh { color: #666666 } /* Literal.Number.Hex */
+.mh { color: #666 } /* Literal.Number.Hex */
-.mi { color: #666666 } /* Literal.Number.Integer */
+.mi { color: #666 } /* Literal.Number.Integer */
-.mo { color: #666666 } /* Literal.Number.Oct */
+.mo { color: #666 } /* Literal.Number.Oct */
 .sa { color: #BA2121 } /* Literal.String.Affix */
 .sb { color: #BA2121 } /* Literal.String.Backtick */
 .sc { color: #BA2121 } /* Literal.String.Char */
@@ -65,9 +66,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .s1 { color: #BA2121 } /* Literal.String.Single */
 .ss { color: #19177C } /* Literal.String.Symbol */
 .bp { color: #008000 } /* Name.Builtin.Pseudo */
-.fm { color: #0000FF } /* Name.Function.Magic */
+.fm { color: #00F } /* Name.Function.Magic */
 .vc { color: #19177C } /* Name.Variable.Class */
 .vg { color: #19177C } /* Name.Variable.Global */
 .vi { color: #19177C } /* Name.Variable.Instance */
 .vm { color: #19177C } /* Name.Variable.Magic */
-.il { color: #666666 } /* Literal.Number.Integer.Long */
+.il { color: #666 } /* Literal.Number.Integer.Long */

blag/static/style.css

@@ -1,32 +1,15 @@
 @import "code-light.css" (prefers-color-scheme: light);
 @import "code-dark.css" (prefers-color-scheme: dark);
 
-@media (prefers-color-scheme: light) {
 :root {
-        --background: #FFFFFF;
+    color-scheme: light dark;
-        --background-dim: #f5f7f9;
+    --background: light-dark(#FFFFFF, #2B363B);
-
+    --background-dim: light-dark(#f5f7f9, #2F3C42);
-        --foreground: #2B303A;
+    --foreground: light-dark(#2B303A, #f0f2f3);
-        --foreground-dim: #576379;
+    --foreground-dim: light-dark(#576379, #d5d5d5);
-        --foreground-heavy: #191C22;
+    --foreground-heavy: light-dark(#191C22, #f2f4f5);
-
+    --primary-color: light-dark(#375287, #A1C5FF);
-        --primary-color: #375287;
 }
-}
-
-@media (prefers-color-scheme: dark) {
-    :root {
-        --background: #2B363B;
-        --background-dim: #2F3C42;
-
-        --foreground: #f0f2f3;
-        --foreground-dim: #d5d5d5;
-        --foreground-heavy: #f2f4f5;
-
-        --primary-color: #A1C5FF;
-    }
-}
-
 
 html {
   font-size: 18px;
@@ -168,3 +151,10 @@ header h2 {
   display: inline;
   font-size: 1.2rem;
 }
+
+hr {
+  border: none;
+  border-top: 1px solid var(--foreground-dim);
+  opacity: 0.3;
+  margin: 2rem 0;
+}

blag/version.py

@@ -1,3 +1,3 @@
 """Version information for the blag package."""
 
-__VERSION__ = "2.2.1"
+__VERSION__ = "2.3.3"

debian/blag-doc.docs

@@ -1 +1 @@
-site/
+site/*

debian/blag.1

@@ -0,0 +1,28 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
+.TH BLAG "1" "July 2024" "blag 2.3.0" "User Commands"
+.SH NAME
+blag \- blog-aware, static site generator
+.SH DESCRIPTION
+usage: blag [\-h] [\-\-version] [\-v] {build,quickstart,serve} ...
+.SS "positional arguments:"
+.IP
+{build,quickstart,serve}
+.TP
+build
+Build website.
+.TP
+quickstart
+Quickstart blag, creating necessary configuration.
+.TP
+serve
+Start development server.
+.SS "options:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-\-version\fR
+show program's version number and exit
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Verbose output.

debian/changelog

@@ -1,3 +1,44 @@
+blag (2.3.3) unstable; urgency=medium
+
+  * Fixed Atom feed encoding to 'utf-8'
+  * Added Python 3.13 to github actions
+  * `requirements*.txt` files are handled by pip-tools. Updates are handled by
+    make update-requirements based on the dependencies described in the
+    pyproject.toml
+
+ -- Bastian Venthur <venthur@debian.org>  Sun, 27 Apr 2025 11:42:13 +0200
+
+blag (2.3.2) unstable; urgency=medium
+
+  * Ignore FileNotFoundError when trying to get the last modified time of
+    files in directories. This happens for example with temporary emacs files.
+  * Added changelog to docs
+  * removed ruff's target-version from pyproject.toml, this value defaults to
+    the projects requires-python
+
+ -- Bastian Venthur <venthur@debian.org>  Sun, 13 Oct 2024 20:12:29 +0200
+
+blag (2.3.1) unstable; urgency=medium
+
+  * added manpage
+  * added makefile target for generating blog's manpage
+  * added makefile target for serving blags docs locally
+  * mkdocs: disabled loading of google fonts, using locally installed system
+    fonts instead
+  * Debian: simplified html docs directory for blag-doc package
+  * Debian: changed section in debian/control from Python to Web
+  * updated dependencies
+
+ -- Bastian Venthur <venthur@debian.org>  Sat, 06 Jul 2024 15:33:36 +0200
+
+blag (2.3.0) unstable; urgency=medium
+
+  * fixed devsever so it does not crash anymore when the (re-)build fails
+  * dropped support for Python 3.8 and 3.9
+  * updated dependencies
+
+ -- Bastian Venthur <venthur@debian.org>  Wed, 24 Apr 2024 22:25:31 +0200
+
 blag (2.2.1) unstable; urgency=medium
 
   * fixed suggests field to blag-doc (Closes: #1055769)

debian/control

@@ -1,24 +1,24 @@
 Source: blag
-Section: python
+Section: web
 Priority: optional
 Maintainer: Bastian Venthur <venthur@debian.org>
 Rules-Requires-Root: no
 Build-Depends:
  debhelper-compat (= 13),
- dh-sequence-python3,
  dh-python,
- pybuild-plugin-pyproject,
+ dh-sequence-python3,
- python3-setuptools,
- python3-all,
- python3-markdown,
- python3-feedgenerator,
- python3-jinja2,
- python3-pygments,
- python3-pytest,
- python3-pytest-cov,
  mkdocs,
  mkdocs-material,
  mkdocstrings-python-handlers,
+ pybuild-plugin-pyproject,
+ python3-all,
+ python3-feedgenerator,
+ python3-jinja2,
+ python3-markdown,
+ python3-pygments,
+ python3-pytest,
+ python3-pytest-cov,
+ python3-setuptools,
 #Testsuite: autopkgtest-pkg-python
 Standards-Version: 4.6.0.1
 Homepage: https://github.com/venthur/blag
@@ -28,8 +28,8 @@ Vcs-Git: https://github.com/venthur/blag.git
 Package: blag
 Architecture: all
 Depends:
- ${python3:Depends},
  ${misc:Depends},
+ ${python3:Depends},
 Suggests:
  blag-doc,
 Description: Blog-aware, static site generator

debian/manpages

@@ -0,0 +1 @@
+debian/blag.1

docs/CHANGELOG.md

@@ -0,0 +1 @@
+../CHANGELOG.md

docs/index.md

@@ -16,7 +16,7 @@ blag is named after [the blag of the webcomic xkcd][blagxkcd].
 ## Features
 
 * Write content in [Markdown][]
-* Good looking default theme
+* Good looking default theme:
   ![Blag Screenshot](blag.png)
 * Theming support using [Jinja2][] templates
 * Generation of Atom feeds for blog content
@@ -24,7 +24,7 @@ blag is named after [the blag of the webcomic xkcd][blagxkcd].
 * Integrated devserver
 * Available on [PyPI][]
 
-blag runs on Linux, Mac and Windows and requires Python >= 3.8
+blag runs on Linux, Mac and Windows and requires Python >= 3.10
 
 [markdown]: https://daringfireball.net/projects/markdown/
 [jinja2]: https://palletsprojects.com/p/jinja/

mkdocs.yml

@@ -13,10 +13,13 @@ nav:
     - blag.markdown: markdown.md
     - blag.devserver: devserver.md
     - blag.quickstart: quickstart.md
+  - Changelog: CHANGELOG.md
 
 theme:
   name: material
   highlightjs: true
+  # disable google fonts, use system fonts
+  font: false
 
 markdown_extensions:
   - pymdownx.superfences

pyproject.toml

@@ -10,13 +10,13 @@ authors = [
 description = "blog-aware, static site generator"
 keywords = ["markdown", "blag", "blog", "static site generator", "cli"]
 readme = "README.md"
-license = { file="LICENSE" }
+license-files = ["LICENSE"]
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 dynamic = ["version"]
 dependencies = [
-    "markdown",
     "feedgenerator",
     "jinja2",
+    "markdown",
     "pygments",
 ]
 
@@ -34,13 +34,13 @@ dev = [
     "mkdocs",
     "mkdocs-material",
     "mkdocstrings[python]",
-    "twine",
+    "mypy",
-    "wheel",
     "pytest",
     "pytest-cov",
     "ruff",
-    "mypy",
+    "twine",
     "types-markdown",
+    "wheel",
 ]
 
 [tool.setuptools.dynamic]
@@ -64,6 +64,9 @@ addopts = """
 """
 
 [tool.ruff]
+line-length = 79
+
+[tool.ruff.lint]
 select = [
     "F",        # pyflakes
     "E", "W",   # pycodestyle
@@ -72,11 +75,7 @@ select = [
     "D",        # pydocstyle
     "UP"        # pyupgrade
 ]
-line-length = 79
+pydocstyle.convention = "numpy"
-target-version = "py38"
-
-[tool.ruff.pydocstyle]
-convention = "numpy"
 
 [tool.mypy]
 files = "blag,tests"

requirements-dev.txt

@@ -1,11 +0,0 @@
-build==1.0.3
-mkdocs==1.5.3
-mkdocs-material==9.4.8
-mkdocstrings[python]==0.23.0
-twine==4.0.2
-wheel==0.41.3
-pytest==7.4.3
-pytest-cov==4.1.0
-ruff==0.1.5
-mypy==1.6.1
-types-markdown==3.5.0.1

requirements.txt

@@ -1,4 +0,0 @@
-markdown==3.5.1
-feedgenerator==2.1.0
-jinja2==3.1.2
-pygments==2.16.1

tests/conftest.py

@@ -1,13 +1,9 @@
 """Pytest fixtures."""
 
-
-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import os
 from argparse import Namespace
+from collections.abc import Callable, Iterator
 from tempfile import TemporaryDirectory
-from typing import Callable, Iterator
 
 import pytest
 from jinja2 import Environment, Template

tests/test_blag.py

@@ -1,9 +1,5 @@
 """Test blag."""
 
-
-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import os
 from argparse import Namespace
 from datetime import datetime
@@ -103,6 +99,15 @@ def test_generate_feed_with_description(cleandir: str) -> None:
     assert '<content type="html">content' in feed
 
 
+def test_feed_is_unicode(cleandir: str) -> None:
+    """Test generate_feed."""
+    articles: list[tuple[str, dict[str, Any]]] = []
+    blag.generate_feed(articles, "build", " ", " ", " ", " ")
+    with open("build/atom.xml") as fh:
+        feed = fh.read()
+    assert 'encoding="utf-8"' in feed
+
+
 def test_parse_args_build() -> None:
     """Test parse_args with build."""
     # test default args

tests/test_devserver.py

@@ -1,17 +1,13 @@
 """Tests for the devserver module."""
 
-
-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import threading
 import time
 from argparse import Namespace
 
-import pytest
-
 from blag import devserver
 
+WAITTIME = 0.1
+
 
 def test_get_last_modified(cleandir: str) -> None:
     """Test get_last_modified."""
@@ -19,13 +15,13 @@ def test_get_last_modified(cleandir: str) -> None:
     t1 = devserver.get_last_modified(["content"])
 
     # wait a bit, create a file and measure again
-    time.sleep(0.1)
+    time.sleep(WAITTIME)
     with open("content/test", "w") as fh:
         fh.write("boo")
     t2 = devserver.get_last_modified(["content"])
 
     # wait a bit and take time again
-    time.sleep(0.1)
+    time.sleep(WAITTIME)
     t3 = devserver.get_last_modified(["content"])
 
     assert t2 > t1
@@ -40,14 +36,14 @@ def test_autoreload_builds_immediately(args: Namespace) -> None:
 
     t = threading.Thread(
         target=devserver.autoreload,
-        args=(args,),
+        args=(args, WAITTIME),
         daemon=True,
     )
     t0 = devserver.get_last_modified(["build"])
     t.start()
     # try for 5 seconds...
     for i in range(5):
-        time.sleep(1)
+        time.sleep(WAITTIME)
         t1 = devserver.get_last_modified(["build"])
         print(t1)
         if t1 > t0:
@@ -55,14 +51,11 @@ def test_autoreload_builds_immediately(args: Namespace) -> None:
     assert t1 > t0
 
 
-@pytest.mark.filterwarnings(
-    "ignore::pytest.PytestUnhandledThreadExceptionWarning"
-)
 def test_autoreload(args: Namespace) -> None:
     """Test autoreload."""
     t = threading.Thread(
         target=devserver.autoreload,
-        args=(args,),
+        args=(args, WAITTIME),
         daemon=True,
     )
     t.start()
@@ -75,8 +68,32 @@ def test_autoreload(args: Namespace) -> None:
 
     # try for 5 seconds to see if we rebuild once...
     for i in range(5):
-        time.sleep(1)
+        time.sleep(WAITTIME)
         t1 = devserver.get_last_modified(["build"])
         if t1 > t0:
             break
     assert t1 > t0
+
+
+def test_autoreload_does_not_crash(args: Namespace) -> None:
+    """Test autoreload does not crash if build fails."""
+    t = threading.Thread(
+        target=devserver.autoreload,
+        args=(args, WAITTIME),
+        daemon=True,
+    )
+    t.start()
+
+    t0 = devserver.get_last_modified(["build"])
+
+    # create a file that causes build to crash
+    with open("content/test.md", "w") as fh:
+        fh.write("date: ")
+
+    # try for 5 seconds to see if we rebuild once...
+    for i in range(5):
+        time.sleep(WAITTIME)
+        t1 = devserver.get_last_modified(["build"])
+        if t1 > t0:
+            break
+    assert t.is_alive()

tests/test_markdown.py

@@ -1,9 +1,5 @@
 """Test markdown module."""
 
-
-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 from datetime import datetime
 from typing import Any
 
@@ -115,3 +111,17 @@ this --- is -- a test ...
     assert "mdash" not in html
     assert "ndash" not in html
     assert "hellip" not in html
+
+
+def test_footnotes() -> None:
+    """Test footnote extension."""
+    md = markdown_factory()
+    md1 = """
+this is a footnote[^1]
+
+[^1]: this is the footnotetext
+"""
+    html, meta = convert_markdown(md, md1)
+    assert "<hr>" in html
+    assert "<ol>" in html
+    assert "footnotetext" in html

tests/test_quickstart.py

@@ -1,9 +1,5 @@
 """Tests for the quickstart module."""
 
-
-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import os
 
 from pytest import MonkeyPatch

tests/test_templates.py

@@ -1,9 +1,5 @@
 """Test the templates."""
 
-
-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import datetime
 
 from jinja2 import Template

tests/test_version.py

@@ -1,9 +1,5 @@
 """Test the version module."""
 
-
-# remove when we don't support py38 anymore
-from __future__ import annotations
-
 import blag