added serve-docs and manpage

This commit is contained in:
Bastian Venthur
2024-07-06 15:18:45 +02:00
parent c3a189f88b
commit 6dd1eee238
3 changed files with 39 additions and 0 deletions

View File

@@ -2,6 +2,9 @@
## [unreleased]
* added manpage
* added makefile target for generating blog's manpage
* added makefile target for serving blags docs locally
* updated dependencies
## [2.3.0] -- 2024-04-24

View File

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

28
debian/blag.1 vendored Normal file
View File

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