Commit graph

44 commits

Author SHA1 Message Date
Chris Mayo
58adec0a28
Merge pull request #599 from cjmayo/sitemap
Use sphinx-sitemap to create a sitemap
2021-12-20 19:25:41 +00:00
Chris Mayo
abd5a68c27 Use sphinx-sitemap to create a sitemap 2021-12-17 19:25:43 +00: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
fe5a34c68f Remove linkcheck.checker.proxysupport
Set up the requests.Session() with the complete proxy configuration
to fix a problem with using an HTTP server as an HTTPS proxy and
potential redirection issues.

Requests handles no_proxy.
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
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
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
4132f245d4 Promote links to the man pages on the home page 2021-01-14 19:48:22 +00:00
Chris Mayo
ffb1d9953c Fix the edit link for the web site front page 2020-10-14 19:28:18 +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
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
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
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
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
21839959b7 Fix typos in man pages 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
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