Commit graph

1029 commits

Author SHA1 Message Date
Chris Mayo
4237a0be76 Update documentation of gh-pages branch 2021-01-14 19:48:22 +00:00
Chris Mayo
1adcea1ff4
Merge branch 'master' into edit-index 2020-10-15 20:02:29 +01:00
Chris Mayo
5ba15f0e0e
Merge branch 'master' into biplist 2020-10-15 19:54:40 +01:00
Chris Mayo
b106723685 Add setup.py build step to documentation 2020-10-15 19:35:24 +01:00
Chris Mayo
ffb1d9953c Fix the edit link for the web site front page 2020-10-14 19:28:18 +01:00
Chris Mayo
a5706e233b Publish documentation to the root of gh-pages 2020-10-14 19:22:59 +01:00
Chris Mayo
a585925d43 Automatically publish documentation on GitHub Pages 2020-10-13 19:28:48 +01:00
Chris Mayo
e922dd0224 Stop using biplist
plistlib has supported binary files since Python 3.4.
2020-10-12 19:55:46 +01:00
Chris Mayo
6fa48359a7
Merge branch 'master' into changes 2020-10-03 17:27:30 +01:00
Chris Mayo
590dc66a67 Update changelog 2020-10-02 19:12:06 +01:00
Chris Mayo
8bd6584c85 Correct documentation of aborttimeout, no matching option
$ grep -rn aborttimeout linkcheck
linkcheck/configuration/confparse.py:167:        self.read_int_option(section, "aborttimeout", min=1)
linkcheck/configuration/__init__.py:184:        self["aborttimeout"] = 300
linkcheck/director/aggregator.py:173:            timeout=strformat.strduration_long(self.config["aborttimeout"]),
linkcheck/director/aggregator.py:200:        timeout = self.config["aborttimeout"]

config["aborttimeout"] is only set from aborttimeout and is the only
value used by Aggregate.abort().
2020-10-02 19:04:40 +01:00
Chris Mayo
319993bb77 Update missed multiline hyperlinks in German linkcheckerrc(5)
Missed from:
1f600ae1 ("Update German man pages", 2020-09-25)
2020-10-02 19:04:40 +01:00
Chris Mayo
1f600ae1c8 Update German man pages 2020-09-25 19:33:15 +01:00
Chris Mayo
26a6ff9259 Run make -C doc locale 2020-09-25 19:33:15 +01:00
Chris Mayo
e875a5f9e5 Assorted German man page translation fixes 2020-09-25 19:33:15 +01:00
Chris Mayo
ee9e00090f Update English man pages because of multiline hyperlinks 2020-09-25 19:33:15 +01:00
Chris Mayo
54e34b2774
Merge pull request #490 from cjmayo/dnspython-2
Fix deprecation warning for resolver.query(), Drop Python 3.5 and add 3.9
2020-09-23 19:52:34 +01:00
Chris Mayo
70d749a967 Drop Python 3.5, add 3.9 2020-09-14 19:55:05 +01:00
Chris Mayo
a074b62c7f Document MarkdownCheck plugin 2020-09-14 19:46:05 +01:00
Chris Mayo
b9390c9ef6
Merge pull request #501 from cjmayo/sphinx3
Document and test Sphinx documentation
2020-09-04 19:26:04 +01:00
Chris Mayo
135c005c3c Document documentation 2020-09-01 19:28:33 +01:00
Chris Mayo
d7680ce117 Don't clean man pages
Allow make code to be used without make man.
2020-09-01 19:28:33 +01:00
Chris Mayo
bfb992fa2b Update example MS Windows batch file
Run LinkChecker after installing with pip on Python from the MS Store.
2020-08-29 16:57:57 +01:00
Chris Mayo
7ef599fc20
Merge pull request #491 from cjmayo/sphinx2
Documentation Updates
2020-08-29 16:50:27 +01:00
Chris Mayo
b1d19e5eab Update copyright and version 2020-08-23 17:24:09 +01:00
Chris Mayo
813f40ac7e Update README and install.txt to only recommend pip git installation 2020-08-23 17:24:09 +01:00
Chris Mayo
67bdc54a00 Add links to MULTILINE section in linkcheckerrc(5) 2020-08-23 17:24:09 +01:00
Chris Mayo
5cc889d7c8 Updates to install.txt 2020-08-23 17:24:09 +01:00
Chris Mayo
2de25d54fd Rename blacklist to failures
Continue to support blacklist for the time being, with deprecation
warnings.
2020-08-23 17:19:26 +01:00
Chris Mayo
54a9364960 Only translate man pages (and index.rst) 2020-08-23 17:19:26 +01:00
Chris Mayo
8919dc6d31 Include CONTRIBUTING and CODE_OF_CONDUCT in Sphinx documentation
Convert to reST to integrate without adding another dependency.
2020-08-15 17:02:40 +01:00
Chris Mayo
0907199216 Include install.txt and upgrading.txt in Sphinx documentation 2020-08-15 17:02:40 +01:00
Chris Mayo
013d9a79c5 Configure man page date format 2020-08-15 17:02:40 +01:00
Chris Mayo
95ddeea635 Add man page description translations 2020-08-15 17:02:40 +01:00
Chris Mayo
57578f0b68 Document that --ignore-url does not skip syntax checking 2020-08-15 17:02:40 +01:00
Chris Mayo
f31932071c Add make -C doc locale 2020-08-15 17:02:40 +01:00
Chris Mayo
d62490d17a Add missing option and settings documentation 2020-08-15 17:02:40 +01:00
Chris Mayo
8e8f7a1668 Fix paths to man pages for make -C doc check 2020-08-15 17:02:40 +01:00
Chris Mayo
fe02eed821 Fix German translation of numbered lists 2020-08-15 17:02:40 +01:00
Chris Mayo
21839959b7 Fix typos in man pages 2020-08-15 17:02:40 +01:00
Chris Mayo
e7a2d2bfc6 Convert French man page translations to Sphinx
This is the automatic conversion only. Much manual work still required.
2020-08-15 17:02:40 +01:00
Chris Mayo
01f41e91de Update man pages, with translations
First man pages generated with Sphinx.
2020-08-15 17:02:40 +01:00
Chris Mayo
334a6a890c Add doc/i18n for man 2020-08-15 17:02:40 +01:00
Chris Mayo
7fcca21c45 Generate man pages with Sphinx 2020-08-15 17:02:40 +01:00
Chris Mayo
22089a5af2 Move man pages into doc/man 2020-08-15 17:02:40 +01:00
Chris Mayo
dc5416bdfd Add PyPI links 2020-08-15 17:02:40 +01:00
Chris Mayo
d1834f0619 Generate html documentation with Sphinx
Create code documentation:
make -C doc code

Create html:
make -C doc html
2020-08-15 17:02:38 +01:00
Chris Mayo
39af879e68 Update the FAQ with plugins for HTML and CSS syntax checking
Options removed in 8.5:
64d95e45 ("Remove local HTML and CSS syntax check.", 2013-02-08)

Plugins added in 9.0:
7b34be59 ("Introduce check plugins, use Python requests for http/s
connections, and some code cleanups and improvements.", 2014-03-01)
2020-08-03 19:47:32 +01:00
Chris Mayo
893875d913 Update Mac installation instructions with Homebrew pip and macOS
The first release of macOS was in 2016.
2020-07-06 19:41:51 +01:00
Chris Mayo
a0df9c3d33
Merge pull request #448 from cjmayo/macinstall
Remove manual setup for OSX from install instructions
2020-06-23 17:45:39 +01:00