Commit graph

38 commits

Author SHA1 Message Date
Chris Mayo
8b2fb86895 Remove AnchorCheck disabled note in linkcheckerrc(5)
A partial revert of:
fe6dea12 ("Update documentation for disabled plugins", 2021-11-29)
2022-10-03 19:33:05 +01:00
Chris Mayo
033dcf89f9
Merge pull request #671 from cjmayo/example
Fix formatting of ignoreerrors example in linkcheckerrc(5)
2022-10-03 19:22:36 +01:00
Chris Mayo
61071fc5dc
Merge pull request #668 from cjmayo/defaults
Clarify default values in initial linkcheckerrc and elsewhere
2022-09-28 19:36:44 +01:00
Chris Mayo
001212b915 Fix formatting of ignoreerrors example in linkcheckerrc(5)
Introduced in:
8c959589 ("add option to ignore specific errors for specific URLs", 2022-07-21)
2022-09-28 19:23:04 +01:00
Lukas Pirl
8c959589c3
add option to ignore specific errors for specific URLs 2022-09-25 22:52:04 +02:00
Chris Mayo
4962a302b3 Document default frequency of sitemap logger 2022-09-22 19:24:55 +01:00
Chris Mayo
b8d0928969 Document dialect option of csv logger 2022-09-22 19:24:55 +01:00
Chris Mayo
a0b28cc0ff Rename url-rate-limited to http-rate-limited
Make consistent with the other warnings:

- The first part of the name represents the checker class in which the
  warning is raised

- Update initial comment
2022-09-06 19:32:24 +01:00
Chris Mayo
d6936ceb91 Add warning url-content-type-unparseable 2022-09-02 19:29:11 +01:00
Chris Mayo
fb8df6f089 Document URL list in linkchecker(1)
First enabled in:
b1708fc7 ("get the complete content", 2004-09-03)
2022-09-02 19:29:11 +01:00
Chris Mayo
f018cc9fd1 Fix typo addtion in linkcheckerrc(5) 2022-09-02 19:17:45 +01:00
Chris Mayo
10f3d33041 Finish documenting the use of XDG_CONFIG_HOME and XDG_DATA_HOME
Introduced by:
a03e2e4a ("use xdg dirs for config & data", 2017-10-17)
2022-08-23 19:21:53 +01:00
Chris Mayo
48a1dde27a Document url-rate-limited
Introduced in:
dcdc64e8 ("Turn status code 429 into warning instead of failure",
2020-03-25)
2022-07-11 19:27:07 +01:00
Chris Mayo
a67e8fd0f5 Test and recommend pdfminer.six for PdfParser
pdfminer is no longer actively maintained; distributions are now
packaging pdfminer.six as pdfminer.
2022-05-18 19:29:54 +01:00
Chris Mayo
de3361fae2 More proxy documentation updates
a60648e34 ("Remove support for ftp_proxy", 2021-12-13)
9504a6ddd ("Document the curl_ca_bundle environment variable", 2021-12-13)
2021-12-17 19:22:20 +00:00
Chris Mayo
315e729ec3 Fix typo "variables" in linkchecker(1) Proxy Support 2021-12-13 19:25:23 +00:00
Chris Mayo
9504a6dddf Document the curl_ca_bundle environment variable 2021-12-13 19:25:23 +00:00
Chris Mayo
a2e379a595 Remove built-in GNOME and KDE proxy support
Only http_proxy was ever supported.

Requests uses urllib.request.getproxies().

Fedora 35 and Ubuntu 20.04 do set proxy environment variables when
settings are added through the GUI.

GNOME location of proxy settings is subject to change:
https://wiki.gnome.org/Projects/NetworkManager/Proxies
https://gitlab.gnome.org/GNOME/gsettings-desktop-schemas/-/issues/27
2021-12-13 19:25:23 +00:00
Chris Mayo
a60648e348 Remove support for ftp_proxy
Was limited to HTTP proxy servers and prevents simplifying and fixing
HTTP proxy support.
2021-12-13 19:25:23 +00:00
Chris Mayo
6269134017 Correct documentation of text output encoding
50ea41b12 ("use preferred locale for default encoding", 2005-10-13)
714147cb2 ("Improved language and encoding detection by using local.getdefaultlocale() instead of locale.getlocale(category=LC_ALL)", 2009-03-04)
2021-11-29 19:48:50 +00:00
Chris Mayo
6de93650f9 Group output documentation 2021-11-29 19:48:50 +00:00
Chris Mayo
a4b14047d6 Make quiet/-q set application logging to warning 2021-11-29 19:48:50 +00:00
Chris Mayo
eb33b1c1e5 Remove --warning-regex documentation
Moved to RegexCheck plugin:
7b34be590 ("Introduce check plugins, use Python requests for http/s connections, and some code cleanups and improvements.", 2014-03-01)
2021-11-29 19:48:50 +00:00
Chris Mayo
a7155db64a Correct documentation of CSV separator
851e1121e ("Use semicolon as default CSV separator.", 2010-07-31)
2021-11-29 19:48:50 +00:00
Chris Mayo
895e2ddb43 Improve documentation of output 2021-11-29 19:48:50 +00:00
Chris Mayo
fe6dea12de Update documentation for disabled plugins 2021-11-29 19:35:34 +00: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
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
a074b62c7f Document MarkdownCheck plugin 2020-09-14 19:46:05 +01:00
Chris Mayo
7ef599fc20
Merge pull request #491 from cjmayo/sphinx2
Documentation Updates
2020-08-29 16:50:27 +01:00
Chris Mayo
67bdc54a00 Add links to MULTILINE section in linkcheckerrc(5) 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
57578f0b68 Document that --ignore-url does not skip syntax checking 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
21839959b7 Fix typos in man pages 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