linkchecker/doc/Makefile

MANFILES:=linkchecker.1 linkcheckerrc.5
LOCALES:=en de

all: html man

html: clean
	make -C src html

locale:
	make -C src locale

man:
	make -C src man; \
	make -C src -e SPHINXOPTS="-D language='de' -t de" LANGUAGE="de" man

# check all man files for formatting warnings
check:
	@for loc in $(LOCALES); do \
	  for manfile in $(MANFILES); do \
	    echo "Checking man/$$loc/$$manfile"; \
	    LC_ALL=en_US.UTF-8 MANWIDTH=80 mandoc -T lint -W error man/$$loc/$$manfile; \
	  done; \
	done

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

.PHONY: check clean html locale man
Move GUI files to separate project 2016-01-23 12:28:15 +00:00			`MANFILES:=linkchecker.1 linkcheckerrc.5`
Check and fix manpage formatting warnings. 2012-10-15 16:19:08 +00:00			`LOCALES:=en de`

Generate man pages with Sphinx 2020-08-06 18:29:24 +00:00			`all: html man`
Switch documentation to the Sphinx documentation generator. git-svn-id: https://linkchecker.svn.sourceforge.net/svnroot/linkchecker/trunk/linkchecker@3919 e7d03fd6-7b0d-0410-9947-9c21f3af8025 2009-01-23 08:34:24 +00:00
Turn all warnings into errors when building website Drop code target, sphinx-autogen is not using conf.py, and since Sphinx 4.0 autosummary is generating stub pages by default anyway. Mock ctypes and linkcheck.__main__: colorama.py imports MS Windows libraries, autosummary executes __main__.py. 2022-11-02 19:24:35 +00:00			`html: clean`
Generate html documentation with Sphinx Create code documentation: make -C doc code Create html: make -C doc html 2020-08-06 18:29:24 +00:00			`make -C src html`
Switch to mandoc for generating html man pages Removes the need for diff files and is a currently maintained project. Cross references are only supported for mdoc macros but because we only have two pages this can be achieved with sed. A clean target is added to the Makefile to make development easier. 2020-04-24 18:46:30 +00:00
Add make -C doc locale 2020-08-09 15:40:55 +00:00			`locale:`
			`make -C src locale`

Generate man pages with Sphinx 2020-08-06 18:29:24 +00:00			`man:`
			`make -C src man; \`
Add man page description translations 2020-08-11 18:16:31 +00:00			`make -C src -e SPHINXOPTS="-D language='de' -t de" LANGUAGE="de" man`
Update HTML man pages on release. 2011-05-30 16:34:43 +00:00
Fix typo makefiles in doc/Makefile 2022-09-05 18:30:38 +00:00			`# check all man files for formatting warnings`
Check and fix manpage formatting warnings. 2012-10-15 16:19:08 +00:00			`check:`
Generate man pages with Sphinx 2020-08-06 18:29:24 +00:00			`@for loc in $(LOCALES); do \`
Check and fix manpage formatting warnings. 2012-10-15 16:19:08 +00:00			`for manfile in $(MANFILES); do \`
Fix paths to man pages for make -C doc check 2020-08-08 15:37:12 +00:00			`echo "Checking man/$$loc/$$manfile"; \`
			`LC_ALL=en_US.UTF-8 MANWIDTH=80 mandoc -T lint -W error man/$$loc/$$manfile; \`
Check and fix manpage formatting warnings. 2012-10-15 16:19:08 +00:00			`done; \`
			`done`

Switch to mandoc for generating html man pages Removes the need for diff files and is a currently maintained project. Cross references are only supported for mdoc macros but because we only have two pages this can be achieved with sed. A clean target is added to the Makefile to make development easier. 2020-04-24 18:46:30 +00:00			`clean:`
Generate html documentation with Sphinx Create code documentation: make -C doc code Create html: make -C doc html 2020-08-06 18:29:24 +00:00			`rm -rf src/_build; \`
			`rm -rf src/code/linkcheck; \`
Don't clean man pages Allow make code to be used without make man. 2020-09-01 18:28:33 +00:00			`rm -rf html`
Switch to mandoc for generating html man pages Removes the need for diff files and is a currently maintained project. Cross references are only supported for mdoc macros but because we only have two pages this can be achieved with sed. A clean target is added to the Makefile to make development easier. 2020-04-24 18:46:30 +00:00
Add make -C doc locale 2020-08-09 15:40:55 +00:00			`.PHONY: check clean html locale man`