prepare new version

Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 4.5.0 to 5.0.0.
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/5.x/CHANGES)
- [Commits](https://github.com/sphinx-doc/sphinx/compare/v4.5.0...v5.0.0)

---
updated-dependencies:
- dependency-name: sphinx
  dependency-type: direct:development
  update-type: version-update:semver-major
...

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

.github/dependabot.yml

@@ -3,4 +3,4 @@ updates:
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"

.github/workflows/python-package.yaml

@@ -17,8 +17,8 @@ jobs:
           - macos-latest
           - windows-latest
         python-version:
-          - 3.8
-          - 3.9
+          - "3.8"
+          - "3.9"
           - "3.10"
 
     steps:

.gitignore

@@ -5,6 +5,9 @@ build/
 dist/
 *.egg-info/
 
+docs/_build/
+docs/api/
+
 htmlcov/
 .coverage
 

CHANGELOG.md

@@ -1,6 +1,34 @@
 # Changelog
 
-## [1.1.0] - 2021-1006
+## [1.3.1] - 2022-06-10
+
+* fixed man page
+
+## [1.3.0] - 2022-06-09
+
+* debianized package
+* Small fix in makefile
+* updated dependencies:
+  * pytest 7.1.2
+  * sphinx 5.0.0
+  * twine 3.7.1
+  * wheel 0.37.1
+  * markdown 3.3.7
+  * jinja 3.1.2
+  * pygments 2.12.0
+
+## [1.2.0] - 2021-11-06
+
+* `make serve` now rebuilds immediately once after called to avoid serving
+  stale files
+* updated dependencies:
+  * feedgenerator 2.0.0
+  * jinja2 3.0.1
+  * pytest-cov 3.0.0
+  * flake8 4.0.1
+  * twine 3.5.0
+
+## [1.1.0] - 2021-10-06
 
 * added Python 3.10 to list of supported versions to test against
 * added dependabot to github workflows

Makefile

@@ -13,6 +13,7 @@ ifeq ($(OS), Windows_NT)
 endif
 
 
+.PHONY: all
 all: lint test
 
 $(VENV): requirements.txt requirements-dev.txt setup.py
@@ -45,6 +46,7 @@ clean:
 	rm -rf build dist *.egg-info
 	rm -rf $(VENV)
 	rm -rf $(DOCS_OUT)
+	rm -rf $(DOCS_SRC)/api
 	find . -type f -name *.pyc -delete
 	find . -type d -name __pycache__ -delete
 	# coverage

README.md

@@ -3,7 +3,7 @@
 blag is a blog-aware, static site generator, written in [Python][].
 
 * an example "deployment" can be found [here][venthur.de]
-* online [documentation][] is available on readthedocs
+* online [documentation][] is available on https://readthedocs.org.
 
 blag is named after [the blag of the webcomic xkcd][blagxkcd].
 
@@ -30,6 +30,21 @@ blag runs on Linux, Mac and Windows and requires Python >= 3.8
 [pypi]: https://pypi.org/project/blag/
 
 
+## Install
+
+blag is available on [PyPI][], you can install it via:
+
+```bash
+$ pip install blag
+```
+
+On Debian or Ubuntu, you can also just install the Debian package:
+
+```bash
+$ sudo aptitude install blag
+```
+
+
 ## Quickstart
 
 ```bash

blag/blag.py

@@ -433,7 +433,7 @@ def quickstart(args):
     base_url = input("Hostname (and path) to the root? "
                      "[https://example.com/]: ")
     title = input("Title of your website? ")
-    description = input("Description of your website [John Does's Blog]? ")
+    description = input("Description of your website [John Doe's Blog]? ")
     author = input("Author of your website [John Doe]? ")
 
     config = configparser.ConfigParser()

blag/devserver.py

@@ -55,6 +55,9 @@ def autoreload(args):
     last modified time). If the last modified time has changed, a
     rebuild is triggered.
 
+    A rebuild is also performed immediately when this method is called
+    to avoid serving stale contents.
+
     Parameters
     ----------
     args : argparse.Namespace
@@ -62,12 +65,14 @@ def autoreload(args):
     """
     dirs = [args.input_dir, args.template_dir, args.static_dir]
     logger.info(f'Monitoring {dirs} for changes...')
-    last_mtime = get_last_modified(dirs)
+    # make sure we trigger the rebuild immediately when we enter the
+    # loop to avoid serving stale contents
+    last_mtime = 0
     while True:
         mtime = get_last_modified(dirs)
         if mtime > last_mtime:
             last_mtime = mtime
-            logger.debug('Change detected, rebuilding...')
+            logger.info('Change detected, rebuilding...')
             blag.build(args)
         time.sleep(1)
 
@@ -84,4 +89,5 @@ def serve(args):
                        directory=args.output_dir))
     proc = multiprocessing.Process(target=autoreload, args=(args,))
     proc.start()
+    logger.info("\n\n  Devserver Started -- visit http://localhost:8000\n")
     httpd.serve_forever()

blag/version.py

@@ -1 +1 @@
-__VERSION__ = '1.1.0'
+__VERSION__ = '1.3.1'

debian/blag-doc.docs

@@ -0,0 +1 @@
+build/html/

debian/blag.install

@@ -0,0 +1 @@
+build/man/blag.1 /usr/share/man/man1

debian/changelog

@@ -0,0 +1,11 @@
+blag (1.3.1) unstable; urgency=medium
+
+  * re-upload with man pages
+
+ -- Bastian Venthur <venthur@debian.org>  Fri, 10 Jun 2022 07:26:19 +0200
+
+blag (1.3.0) unstable; urgency=medium
+
+  * Initial release. Closes: #1012584
+
+ -- Bastian Venthur <venthur@debian.org>  Sun, 05 Jun 2022 15:20:48 +0200

debian/control

@@ -0,0 +1,59 @@
+Source: blag
+Section: python
+Priority: optional
+Maintainer: Bastian Venthur <venthur@debian.org>
+Rules-Requires-Root: no
+Build-Depends:
+ debhelper-compat (= 13),
+ dh-sequence-sphinxdoc,
+ dh-sequence-python3,
+ dh-python,
+ python3-setuptools,
+ python3-all,
+ python3-markdown,
+ python3-feedgenerator,
+ python3-jinja2,
+ python3-pygments,
+ python3-pytest,
+ python3-pytest-cov,
+ python3-sphinx,
+#Testsuite: autopkgtest-pkg-python
+Standards-Version: 4.6.0.1
+Homepage: https://github.com/venthur/blag
+Vcs-Browser: https://github.com/venthur/blag
+Vcs-Git: https://github.com/venthur/blag.git
+
+Package: blag
+Architecture: all
+Depends:
+ ${python3:Depends},
+ ${misc:Depends},
+Suggests:
+ python-blag-doc,
+Description: Blog-aware, static site generator
+ Blag is a blog-aware, static site generator, written in Python. It supports
+ the following features:
+   * Write content in Markdown
+   * Theming support using Jinja2 templates
+   * Generation of Atom feeds for blog content
+   * Fenced code blocks and syntax highlighting using Pygments
+   * Integrated devserver
+   * Available on PyPI
+
+Package: blag-doc
+Section: doc
+Architecture: all
+Depends:
+ ${sphinxdoc:Depends},
+ ${misc:Depends},
+Description: Blog-aware, static site generator (documentation)
+ Blag is a blog-aware, static site generator, written in Python. It supports
+ the following features:
+   * Write content in Markdown
+   * Theming support using Jinja2 templates
+   * Generation of Atom feeds for blog content
+   * Fenced code blocks and syntax highlighting using Pygments
+   * Integrated devserver
+   * Available on PyPI
+ .
+ This is the common documentation package.

debian/copyright

@@ -0,0 +1,35 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Source: https://github.com/venthur/blag
+Upstream-Name: blag
+Upstream-Contact: Bastian Venthur venthur@debian.org
+
+Files:
+ *
+Copyright:
+ 2022 Bastian Venthur venthur@debian.org
+License: MIT
+
+Files:
+ debian/*
+Copyright:
+ 2022 Bastian Venthur <venthur@debian.org>
+License: MIT
+
+License: MIT
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+ .
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+ .
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.

debian/rules

@@ -0,0 +1,25 @@
+#!/usr/bin/make -f
+
+# See debhelper(7) (uncomment to enable).
+# Output every command that modifies files on the build system.
+#export DH_VERBOSE = 1
+
+export PYBUILD_DESTDIR=debian/blag
+export PYBUILD_TEST_ARGS=--no-cov
+export PYBUILD_NAME=blag
+
+%:
+	dh $@ --with python3,sphinxdoc --buildsystem=pybuild
+
+
+# If you need to rebuild the Sphinx documentation:
+# Add sphinxdoc to the dh --with line.
+#
+# And uncomment the following lines.
+execute_after_dh_auto_build-indep: export http_proxy=127.0.0.1:9
+execute_after_dh_auto_build-indep: export https_proxy=127.0.0.1:9
+execute_after_dh_auto_build-indep:
+	PYTHONPATH=. python3 -m sphinx -N -bhtml \
+	docs/ build/html # HTML generator
+	PYTHONPATH=. python3 -m sphinx -N -bman \
+	docs/ build/man # Manpage generator

debian/source/format

@@ -0,0 +1 @@
+3.0 (native)

requirements-dev.txt

@@ -1,6 +1,6 @@
-sphinx==4.2.0
-twine==3.4.2
-wheel==0.37.0
-pytest==6.2.5
-pytest-cov==2.12.1
-flake8==3.9.2
+sphinx==5.0.0
+twine==4.0.0
+wheel==0.37.1
+pytest==7.1.2
+pytest-cov==3.0.0
+flake8==4.0.1

requirements.txt

@@ -1,4 +1,4 @@
-markdown==3.3.4
-feedgenerator==1.9.2
-jinja2==3.0.1
-pygments==2.10.0
+markdown==3.3.7
+feedgenerator==2.0.0
+jinja2==3.1.2
+pygments==2.12.0

tests/test_devserver.py

@@ -1,4 +1,7 @@
 import time
+import threading
+
+import pytest
 
 from blag import devserver
 
@@ -19,3 +22,45 @@ def test_get_last_modified(cleandir):
 
     assert t2 > t1
     assert t2 == t3
+
+
+def test_autoreload_builds_immediately(args):
+    # create a dummy file that can be build
+    with open('content/test.md', 'w') as fh:
+        fh.write('boo')
+
+    t = threading.Thread(target=devserver.autoreload,
+                         args=(args, ),
+                         daemon=True,)
+    t0 = devserver.get_last_modified(['build'])
+    t.start()
+    # try for 5 seconds...
+    for i in range(5):
+        time.sleep(1)
+        t1 = devserver.get_last_modified(['build'])
+        print(t1)
+        if t1 > t0:
+            break
+    assert t1 > t0
+
+
+@pytest.mark.filterwarnings("ignore::pytest.PytestUnhandledThreadExceptionWarning")  # noqa
+def test_autoreload(args):
+    t = threading.Thread(target=devserver.autoreload,
+                         args=(args, ),
+                         daemon=True,)
+    t.start()
+
+    t0 = devserver.get_last_modified(['build'])
+
+    # create a dummy file that can be build
+    with open('content/test.md', 'w') as fh:
+        fh.write('boo')
+
+    # try for 5 seconds to see if we rebuild once...
+    for i in range(5):
+        time.sleep(1)
+        t1 = devserver.get_last_modified(['build'])
+        if t1 > t0:
+            break
+    assert t1 > t0