From c4c54526c59449b45144c54015469ab5b341e1d8 Mon Sep 17 00:00:00 2001 From: ge Date: Sat, 13 Aug 2022 19:35:11 +0300 Subject: [PATCH] feat: Update man build --- Makefile | 28 +++++++++++++------ README.md | 6 ++-- ...ng-backup.1.rst => boring-backup.ru.1.rst} | 0 3 files changed, 22 insertions(+), 12 deletions(-) rename docs/{boring-backup.1.rst => boring-backup.ru.1.rst} (100%) diff --git a/Makefile b/Makefile index 47a2a9f..fd6a9ea 100644 --- a/Makefile +++ b/Makefile @@ -6,21 +6,25 @@ docs_build_dir := ./build/docs .PHONY: help tests docs +all: man + help: @echo Usage: make TARGET @echo @echo Available targets: @echo @echo 'help print this help message' - @echo 'tests run tests from $(tests_dir)' + @echo 'test run tests from $(tests_dir)' @echo 'lint run shellcheck' - @echo 'docs build documentation from $(docs_dir)' + @echo 'man build manual pages from $(docs_dir)' @echo @echo See README.md for more info. -tests: +test: # See bats(1), https://bats-core.readthedocs.io/en/latest/index.html - for test in $(tests_dir)/*.bats; do bats --verbose-run --print-output-on-failure "$$test"; done + for test in $(tests_dir)/*.bats; do \ + bats --verbose-run --print-output-on-failure "$$test"; \ + done lint: shellcheck $(src_dir)/boring-backup @@ -28,11 +32,17 @@ lint: shellcheck $(src_dir)/lib/handlers/sources/*.sh shellcheck $(src_dir)/lib/handlers/targets/*.sh -docs: builddir - # See rst2man(1), rst2html(1), https://docutils.sourceforge.io/docs/index.html - rst2man $(docs_dir)/boring-backup.1.rst | gzip -9 > $(docs_build_dir)/boring-backup.1.gz - rst2html $(docs_dir)/boring-backup.1.rst > $(docs_build_dir)/boring-backup.1.html +man: build_dir + # See rst2man(1), rst2html(1), + # https://docutils.sourceforge.io/docs/index.html + rst2man $(docs_dir)/boring-backup.ru.1.rst \ + > $(docs_build_dir)/boring-backup.ru.1 + sed -e 's/.SH NAME/.SH ИМЯ/' \ + -e 's/.SH AUTHOR/.SH АВТОРЫ/' \ + -e 's/.SH COPYRIGHT/.SH АВТОРСКИЕ ПРАВА/' \ + -i $(docs_build_dir)/boring-backup.ru.1 + gzip -9 $(docs_build_dir)/boring-backup.ru.1 -builddir: +build_dir: mkdir -p $(build_dir) mkdir -p $(docs_build_dir) diff --git a/README.md b/README.md index 6582cfa..a7ba869 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Add some Bats extensions: Run tests: - make tests + make test # Linting @@ -28,6 +28,6 @@ Run shellcheck: # Building -Build docs (manpage and HTML): +Build manpages: - make docs + make man diff --git a/docs/boring-backup.1.rst b/docs/boring-backup.ru.1.rst similarity index 100% rename from docs/boring-backup.1.rst rename to docs/boring-backup.ru.1.rst