add strikethru and footnotes functionality

Bump the all group with 6 updates

.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

@@ -17,19 +17,13 @@ jobs:
           - macos-latest
           - windows-latest
         python-version:
-          - "3.8"
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
-        exclude:
-          # 3.8 on windows fails due to some pip issue
-          - os: windows-latest
-            python-version: "3.8"
 
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -43,7 +37,7 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: "3.x"
 
@@ -57,7 +51,7 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: "3.x"
 
@@ -72,7 +66,7 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: "3.x"
 

CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+
+## [2.4.0] -- 2024-09-05
+
+* added strikethru and footnotes to blag renders.
+
+## [unreleased] --
+
+* Added changelog to docs
+
+## [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

@@ -57,6 +57,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

@@ -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/

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

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
@@ -52,7 +49,7 @@ def get_last_modified(dirs: list[str]) -> float:
     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 +63,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 +74,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
@@ -33,6 +30,8 @@ def markdown_factory() -> Markdown:
     """
     md = Markdown(
         extensions=[
+            "footnotes",        # Add footnotes support
+            "pymdownx.tilde",   # Add strukethrough support
             "meta",
             "fenced_code",
             "codehilite",

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,35 +4,36 @@ 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 */
 .g { color: #f8f8f2 } /* Generic */
 .k { color: #66d9ef } /* Keyword */
 .l { color: #ae81ff } /* Literal */
 .n { color: #f8f8f2 } /* Name */
-.o { color: #f92672 } /* Operator */
+.o { color: #ff4689 } /* Operator */
 .x { color: #f8f8f2 } /* Other */
 .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 */
+.ges { color: #f8f8f2; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .gr { color: #f8f8f2 } /* Generic.Error */
 .gh { color: #f8f8f2 } /* Generic.Heading */
 .gi { color: #a6e22e } /* Generic.Inserted */
 .go { color: #66d9ef } /* Generic.Output */
-.gp { color: #f92672; font-weight: bold } /* Generic.Prompt */
+.gp { color: #ff4689; font-weight: bold } /* Generic.Prompt */
 .gs { color: #f8f8f2; font-weight: bold } /* Generic.Strong */
-.gu { color: #75715e } /* Generic.Subheading */
+.gu { color: #959077 } /* Generic.Subheading */
 .gt { color: #f8f8f2 } /* Generic.Traceback */
 .kc { color: #66d9ef } /* Keyword.Constant */
 .kd { color: #66d9ef } /* Keyword.Declaration */
-.kn { color: #f92672 } /* Keyword.Namespace */
+.kn { color: #ff4689 } /* Keyword.Namespace */
 .kp { color: #66d9ef } /* Keyword.Pseudo */
 .kr { color: #66d9ef } /* Keyword.Reserved */
 .kt { color: #66d9ef } /* Keyword.Type */
@@ -51,9 +52,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .nn { color: #f8f8f2 } /* Name.Namespace */
 .nx { color: #a6e22e } /* Name.Other */
 .py { color: #f8f8f2 } /* Name.Property */
-.nt { color: #f92672 } /* Name.Tag */
+.nt { color: #ff4689 } /* Name.Tag */
 .nv { color: #f8f8f2 } /* Name.Variable */
-.ow { color: #f92672 } /* Operator.Word */
+.ow { color: #ff4689 } /* Operator.Word */
 .pm { color: #f8f8f2 } /* Punctuation.Marker */
 .w { color: #f8f8f2 } /* Text.Whitespace */
 .mb { color: #ae81ff } /* Literal.Number.Bin */

blag/static/code-light.css

@@ -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 */

blag/version.py

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

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,24 @@
+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

push

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+
+REPO="gitea"
+
+
+
+python3 -m pip install --upgrade twine
+
+
+python3 -m twine upload --repository $REPO dist/*

pyproject.toml

@@ -11,7 +11,7 @@ description = "blog-aware, static site generator"
 keywords = ["markdown", "blag", "blog", "static site generator", "cli"]
 readme = "README.md"
 license = { file="LICENSE" }
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 dynamic = ["version"]
 dependencies = [
     "markdown",
@@ -64,6 +64,10 @@ addopts = """
 """
 
 [tool.ruff]
+line-length = 79
+target-version = "py310"
+
+[tool.ruff.lint]
 select = [
     "F",        # pyflakes
     "E", "W",   # pycodestyle
@@ -72,11 +76,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 +1,11 @@
-build==1.0.3
+build==1.2.1
-mkdocs==1.5.3
+mkdocs==1.6.0
-mkdocs-material==9.4.8
+mkdocs-material==9.5.31
-mkdocstrings[python]==0.23.0
+mkdocstrings[python]==0.25.2
-twine==4.0.2
+twine==5.1.1
-wheel==0.41.3
+wheel==0.44.0
-pytest==7.4.3
+pytest==8.3.2
-pytest-cov==4.1.0
+pytest-cov==5.0.0
-ruff==0.1.5
+ruff==0.6.0
-mypy==1.6.1
+mypy==1.11.1
-types-markdown==3.5.0.1
+types-markdown==3.6.0.20240316

requirements.txt

@@ -1,4 +1,5 @@
-markdown==3.5.1
+markdown==3.6
 feedgenerator==2.1.0
-jinja2==3.1.2
+jinja2==3.1.4
-pygments==2.16.1
+pygments==2.18.0
+pymdown-extensions==10.9

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

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
 

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