Skip to content

Commit

Permalink
Generate man pages with Sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
cjmayo committed Aug 15, 2020
1 parent 22089a5 commit 7fcca21
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 2,944 deletions.
3 changes: 1 addition & 2 deletions MANIFEST.in
Expand Up @@ -42,8 +42,7 @@ recursive-include doc \
*.txt \
*.yml \
Makefile \
linkcheckerrc_* \
po4a.conf
linkcheckerrc_*
recursive-include po \
*.mo \
*.po \
Expand Down
18 changes: 9 additions & 9 deletions doc/Makefile
@@ -1,31 +1,31 @@
MANFILES:=linkchecker.1 linkcheckerrc.5
LOCALES:=en de

all:
all: html man

code: clean
PYTHONPATH=.. sphinx-autogen src/code/index.rst

html:
make -C src html

po4a:
po4a --localized-charset=UTF-8 po4a.conf
man:
make -C src man; \
make -C src -e SPHINXOPTS="-D language='de'" LANGUAGE="de" man

# check all makefiles for formatting warnings
check:
@t=$(shell tempfile); \
for loc in $(LOCALES); do \
@for loc in $(LOCALES); do \
for manfile in $(MANFILES); do \
echo "Checking $$loc/$$manfile"; \
LC_ALL=en_US.UTF-8 MANWIDTH=80 man --warnings -E UTF-8 -l $$loc/$$manfile > /dev/null 2>$$t ; \
if [ -s $$t ]; then cat $$t; exit 1; fi; \
LC_ALL=en_US.UTF-8 MANWIDTH=80 mandoc -T lint -W error $$loc/$$manfile; \
done; \
done

clean:
rm -rf src/_build; \
rm -rf src/code/linkcheck; \
rm -rf html
rm -rf html; \
rm -rf man

.PHONY: po4a check clean html
.PHONY: check clean html man

0 comments on commit 7fcca21

Please sign in to comment.