Commit graph

1043 commits

Author SHA1 Message Date
Chris Mayo
fe6dea12de Update documentation for disabled plugins 2021-11-29 19:35:34 +00:00
Chris Mayo
af93386bcc Version application using setuptools_scm
Version has the format X.Y.Z.postN+g12345678
2021-11-28 18:55:46 +00:00
Chris Mayo
e297b1a477 Stop including binary translation catalogs in the source
Makes it easier to contribute and accept translations.

Does add a new dependency on installation from source, polib. This is
not made mandatory because not all users will want translations.

polib has no further dependencies and can be installed anywhere
LinkChecker can, using pip too.

Add release process step to check polib is installed

The Wheel still includes translations. Recommend install from PyPI in
the README.

Translations were being compiled in setup.py until 2014, using a bundled
copy of msgfmt.py.
9c3739f1c ("Replace msgfmt.py with local tools.", 2014-09-08)
2021-11-22 19:30:33 +00:00
Chris Mayo
1194f5d943 Update pip URL in install.txt 2021-11-22 19:30:33 +00:00
Chris Mayo
d99e600edd Add translation .po file checks 2021-11-22 19:30:33 +00:00
Chris Mayo
119f6a961e Use an HTML list for custom menu entries in documentation
For compatibility with sphinx_rtd_theme 1.0, which otherwise renders the
entries with buttons.
2021-08-22 19:26:03 +01:00
Chris Mayo
49d994d7cc Reference GitHub Actions instead of Travis in documentation 2021-08-22 19:26:03 +01:00
Chris Mayo
b9b4936729 Fix broken Edit on GitHub links in documentation 2021-08-12 19:28:50 +01:00
Paul Haerle
f395c74aac
Make ResultCache max_size configurable (#544)
* Make ResultCache max_size configurable

fixes #463

* Add tests and docs.

* fix documentation...

...adapt the source, not the auto-generated man pages themselves as
requested in #544.

* fix typo.
2021-06-21 19:45:19 +01:00
Chris Mayo
c4b8a4aeec Changes for release 10.0.1 2021-01-28 19:20:24 +00:00
Chris Mayo
b84aac8de9 Update copyright in man pages 2021-01-28 19:20:24 +00:00
Chris Mayo
e7e9c3a865 Update release process 2021-01-28 19:20:24 +00:00
Chris Mayo
732f988500 Changes for release 10.0.0 2021-01-14 19:48:22 +00:00
Chris Mayo
4132f245d4 Promote links to the man pages on the home page 2021-01-14 19:48:22 +00:00
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