Commit graph

1119 commits

Author SHA1 Message Date
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
Chris Mayo
da22d4886b
Merge pull request #441 from cjmayo/authentication
Improve documentation of authentication
2020-06-23 17:35:19 +01:00
Chris Mayo
a9097bf277 Document that HTTP POST is used for loginurl 2020-06-23 17:28:31 +01:00
Chris Mayo
2f51a9dca0 Improve documentation of authentication 2020-06-23 17:28:31 +01:00
Chris Mayo
b8be24e389 Remove manual setup for OSX from install instructions
py2app support was removed in:
e3ab9024 ("Remove platform-specific installer stuff and ensure a build
.whl wheel file can be built.", 2016-01-17)
2020-06-19 16:57:01 +01:00
Chris Mayo
f494b62981 Copy date and add translation for GNOME/KDE to de.po 2020-06-11 19:35:02 +01:00
Chris Mayo
11900984e2 Run po4a on doc translatios after GNOME proxy update 2020-06-05 16:29:45 +01:00
Chris Mayo
b9c8e33878 Update GNOME proxy support for GNOME 3 and Python 3
GConf is replaced by dconf and the GSettings API in GNOME 3.
2020-06-05 16:29:45 +01:00
Chris Mayo
d0bccf885a Update German doc translations
No new German; existing German translations moved into new strings
created by man page reformatting. Universal strings also copied across.

a205a372 ("Update man pages to optimise for both html and man", 2020-04-24)
2020-06-05 16:06:01 +01:00
Chris Mayo
18e7ea8c57 Run po4a on doc translations 2020-06-05 16:06:01 +01:00
Chris Mayo
0a702240d9 Document use of make for translation 2020-06-05 16:06:01 +01:00
Chris Mayo
8dcdb4d387 Don't recommend sudo for pip
https://packaging.python.org/tutorials/installing-packages/
2020-06-01 19:48:26 +01:00
Chris Mayo
62dc394159 Add pip instructions for Windows and Mac OS X 2020-06-01 16:23:33 +01:00
Chris Mayo
b01c685201 Update README.rst, install.txt and upgrading.txt 2020-06-01 16:23:33 +01:00
Chris Mayo
33e085661f Update website for Python 3 2020-06-01 16:23:33 +01:00
Chris Mayo
a61424c15b Remove html patch reject file 2020-06-01 16:23:33 +01:00
Chris Mayo
cf7aff2770 Fix remaining flake8 violations in doc/ and scripts/
doc/web/hooks/__hooks__.py:31:57: E999 SyntaxError: invalid token
scripts/analyze_memdump.py:42:12: E999 SyntaxError: invalid syntax
scripts/analyze_memdump.py:85:89: E501 line too long (105 > 88 characters)
scripts/analyze_memdump.py:132:89: E501 line too long (97 > 88 characters)
scripts/update_iana_uri_schemes.py:90:13: E999 SyntaxError: invalid syntax
2020-05-26 20:20:57 +01:00
Chris Mayo
fbf3a8ab20 Run black on doc/ 2020-05-26 20:20:57 +01:00
Chris Mayo
50df8035d0
Merge pull request #413 from cjmayo/deprecated_options
Remove ineffective command-line options
2020-05-26 19:44:28 +01:00
Marius Gedminas
43d1403b1b Remove unused screenshot
git grep tells me shot2.png is not referenced anywhere in the tree.  It
depicts the old, removed Qt GUI.
2020-05-25 22:25:48 +03:00
Chris Mayo
3c62adb1ba Remove ineffective command-line options
These options were replaced by plugins and made ineffective [1]. This change
was included in the 9.0 release.

[1] 7b34be59 ("Introduce check plugins, use Python requests for http/s
    connections, and some code cleanups and improvements.", 2014-03-01)
2020-05-25 19:27:11 +01:00
Chris Mayo
083aa164e8 Add codename and release date for 9.4 to changelog.txt 2020-05-25 19:27:11 +01:00
Chris Mayo
c60887cc63 Rename .mdwn files to .md
- RFC 7763 file extensions are .md and .markdown
- Consistent with other documentation files
2020-05-22 19:43:57 +01:00
Chris Mayo
87f0c31928 Remove linkchecker.desktop
- Not useful for a command-line application
- Refers to an icon with a generic name, that is not installed
2020-05-22 19:43:57 +01:00
anarcat
8183b7feb8
Update doc/install.txt
Co-authored-by: Marius Gedminas <marius@gedmin.as>
2020-05-19 12:05:21 -04:00
Antoine Beaupré
2c9bc4e7ba
do not require ssh to clone from source
Closes: #389
2020-05-19 11:04:15 -04:00
Chris Mayo
1663e10fe7 Remove spaces after names in function definitions
This is a PEP 8 convention, E211.
2020-05-16 20:19:42 +01:00
Chris Mayo
b0ea72e8c1 Remove # -*- coding: lines
Except for tests that include non-unicode characters:

tests/test_po.py
tests/test_strformat.py
tests/test_url.py
tests/checker/test_error.py
tests/checker/test_news.py
2020-05-08 10:45:31 +01:00
Chris Mayo
b7c8ad9be7 Fix typo for -Dplugin in man page 2020-04-24 19:46:30 +01:00
Chris Mayo
5dd448cf05 Add link to unknownurl.py in man page 2020-04-24 19:46:30 +01:00
Chris Mayo
a506800c07 Replace `` in man page with bold formatting 2020-04-24 19:46:30 +01:00
Chris Mayo
e3b77f810e Update external links in man pages to https 2020-04-24 19:46:30 +01:00
Chris Mayo
a205a3722b Update man pages to optimise for both html and man
- Use "LinkChecker User Manual" as the source for both pages.
- .UR/.UE for external links to allow mandoc to create links in html.
- Use Linux man-pages format for cross references e.g.
  .BR linkcheckerrc (5) which are replace in the html by the Makefile.
2020-04-24 19:46:30 +01:00
Chris Mayo
441cda5e15 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 19:46:30 +01:00
Marius Gedminas
61b30a95dd Switch to travis-ci.com
Migrating from legacy GitHub services/webhooks to the new Travis CI
GitHub app means we also have to use travis-ci.com instead of
travis-ci.org to see build status or history.
2020-03-31 18:35:37 +03:00
Chris Mayo
9030050599 Remove Python 3 status document 2020-03-30 17:39:23 +01:00
EsuS
004632a99b Update references to GitHub project from wummel to linkchecker
Remove all mention of donations.
2019-04-18 19:59:52 +01:00
anarcat
7aaebdeda9
Merge pull request #138 from anarcat/std-contrib
improve contrib guidelines
2018-06-21 09:07:54 -04:00
Antoine Beaupré
ad46816a85
replace old links on website
point to the new orga at least while we figure out namespace issues

Closes: #112
2018-04-12 09:24:31 -04:00
Antoine Beaupré
afad6c80a2
prepare 9.4.0 release 2018-04-11 19:58:09 -04:00
Antoine Beaupré
a2a6954b42
split code of conduct and contributing guidelines in two
This ensure the files are in standard locations so that GitHub finds
them. This will hopefully help people provide more detailed bug
reports in the future as well.
2018-03-26 09:35:01 -04:00
Félix Sipma
e94fd3b4d8 mention #44 in changelog entry 2017-10-18 16:10:05 +02:00
Félix Sipma
7344a3c40b update changelog 2017-10-18 16:02:56 +02:00
anarcat
dde8d798b5 fix typo
see #77
2017-08-29 08:27:17 -04:00
Harry Wood
36ba1855d2 Remove reference to non existent .dmg file
Pending a resolution to https://github.com/linkcheck/linkchecker/issues/60 

(re-rolling this PR here https://github.com/wummel/linkchecker/pull/640 )
2017-08-01 22:23:18 +01:00
Antoine Beaupré
f56f6a3071 fix typo 2017-02-10 12:04:32 -05:00
Antoine Beaupré
ede76dcee7 fix weird line ending issue 2017-02-10 10:42:32 -05:00
Antoine Beaupré
74487aec5b use more consistently "maintainer" instead of "member"
tough call, but i think it actually matters... In the code of conduct,
a "community member" is not necessarily an official status. by
conflating the "maintainer" and "member" status, we would have
diminished the role of non-official members... People are a member of
the community when they participate, regardless of their official
status, and deserve the same respect as anyone else.

also use "administrator" instead of "owner". i do not "own" this
project, i administer it. we do not have to comply with GitHub's
proprietary vocabulary
2017-02-10 09:11:47 -05:00
Antoine Beaupré
df82d8c878 add exception that changes to the contribution document must have consensus among the owners 2017-02-10 09:04:16 -05:00
Antoine Beaupré
11025103b6 explicitely state that all PRs must be reviewed before merge 2017-02-10 09:04:00 -05:00
Antoine Beaupré
d097567a50 allow urgent self-merges 2017-02-10 09:02:42 -05:00
Antoine Beaupré
7731f098ee remove double-negative 2017-02-10 09:01:53 -05:00
Antoine Beaupré
f07b581517 remove another duplicate sentence 2017-02-10 09:01:26 -05:00
Antoine Beaupré
b20b2949b0 s/Github/GitHub/ 2017-02-10 09:00:22 -05:00
Antoine Beaupré
8ed6c0cc26 remove duplicate sentence 2017-02-10 09:00:01 -05:00
Antoine Beaupré
92cbe36742 clarify that all supported platforms should test 2017-02-10 08:59:30 -05:00
Antoine Beaupré
c8dab7d08c rephrase and expand timeframe 2017-02-10 08:58:46 -05:00
Antoine Beaupré
7162371140 clarify that labeling is privileged 2017-02-10 08:57:22 -05:00
Antoine Beaupré
fad1b72c31 clarify who regular users are 2017-02-10 08:56:16 -05:00
Antoine Beaupré
a9cb943c38 also build sdist files 2017-02-10 08:52:54 -05:00
Antoine Beaupré
c84621eb79 move code of conduct to a separate document, add other guidelines 2017-02-10 08:51:26 -05:00
Antoine Beaupré
a2fce98262 adapt the code of conduct to our community, add myself as contact 2017-02-09 18:27:22 -05:00
Antoine Beaupré
9d2cec525f import Covenant's Code of Conduct 1.4 2017-02-09 17:52:44 -05:00
Antoine Beaupré
bcacd8bd21 fix file extension for development file, it's markdown 2017-02-09 17:50:16 -05:00
Antoine Beaupré
caf5ea6984 draft a release process 2017-01-31 12:25:57 -05:00
Bastian Kleineidam
0ef00eea56 Move GUI files to separate project 2016-01-23 13:28:15 +01:00
wummel
4de5348b9d Merge pull request #575 from sitsofe/master
Expand RegexCheck docs and fix up some typos.
2016-01-19 21:59:42 +01:00
Bastian Kleineidam
549533d701 Improved debugging 2016-01-19 21:55:50 +01:00
Florian Jacob
fa262a0894 Make documentation reflect 39df181
10 instead of 100 default threads
2015-09-15 11:15:04 +02:00
Sitsofe Wheeler
40be399f79 Fix up some typos and grammar in the linkcheckerrc man page. 2015-02-11 10:42:03 +00:00
Sitsofe Wheeler
ed683bc4c0 Expand RegexCheck section.
- Add the warningregex parameter to the RegexCheck section.
- Add a note that the REGEX shouldn't be quoted.
- Change the quote style to double quotes to match the rest of the document.
2015-02-11 10:41:57 +00:00
Bastian Kleineidam
27937e6f83 Fix requests module version check. 2014-09-22 22:45:04 +02:00
Bastian Kleineidam
228bce1ba2 Add to instead of replace the HTTP client headers. 2014-09-20 12:17:42 +02:00
Bastian Kleineidam
9960c179fb Updated
[ci skip]
2014-09-11 21:20:37 +02:00
Bastian Kleineidam
3d459218bf Mention that Python 3 is not yet supported.
[ci skip]
2014-09-11 19:43:06 +02:00
Bastian Kleineidam
21c7200360 Reactivate paging of help pages. 2014-09-11 19:42:42 +02:00
Bastian Kleineidam
9c3739f1c9 Replace msgfmt.py with local tools. 2014-09-08 18:25:03 +02:00
Bastian Kleineidam
06c6b80ed3 Fix proxy support. 2014-09-05 22:48:10 +02:00
Bastian Kleineidam
c580c0ec52 Document user-agent string.
[ci skip]
2014-09-05 22:47:26 +02:00
Bastian Kleineidam
ee4545399d Support itms-services: URLs. #532 2014-09-05 21:06:10 +02:00
Bastian Kleineidam
c94ef87d14 Bump up version; fix README.rst name in MANIFEST.in 2014-07-16 20:50:39 +02:00
Bastian Kleineidam
3301a5a731 Updated
[ci skip]
2014-07-16 20:35:15 +02:00
Bastian Kleineidam
4b2531ef98 Set release date. 2014-07-16 07:34:21 +02:00
Bastian Kleineidam
37664ea8a4 Fix Word file check plugin. 2014-07-15 22:39:41 +02:00
Bastian Kleineidam
90257a1b5e Replace twill with custom code. 2014-07-15 18:37:05 +02:00
Bastian Kleineidam
a665d35feb Use proxies and checker session in robots.txt. 2014-07-14 20:28:28 +02:00
Bastian Kleineidam
6c38b4165a Use given HTTP auth data for robots.txt fetching. 2014-07-14 19:50:11 +02:00
Bastian Kleineidam
05aa4ec1f6 A proper error message on Python 2.6 is not possible. Document Python 2.7.2 dependency in prominent places instead. Closes #517 2014-07-13 22:05:02 +02:00
Bastian Kleineidam
446f971e0c Updated changelog
[ci skip]
2014-07-13 21:57:14 +02:00
Bastian Kleineidam
176b95a30e Do not strip quotes from resolved URLs. 2014-07-11 00:43:46 +02:00
Bastian Kleineidam
0fa7ed2699 Fix empty URL handling. 2014-07-03 23:34:40 +02:00
Bastian Kleineidam
7c2e40e77f Updated changelog
[ci skip]
2014-07-01 21:16:38 +02:00
Bastian Kleineidam
cde261c009 Parse Refresh: and Content-Location: header values for URLs. 2014-07-01 20:16:43 +02:00
Bastian Kleineidam
c3ec91ac6d Fix intern URL search pattern. 2014-06-13 23:52:21 +02:00
Bastian Kleineidam
3760d2a7cc Improved wording
[ci skip]
2014-05-10 21:22:47 +02:00
Bastian Kleineidam
fa864e4a14 Updated changelog.
[ci skip]
2014-04-28 18:13:51 +02:00
Bastian Kleineidam
82dd76b0d7 Add PDF link parsing. 2014-04-28 18:13:45 +02:00
Bastian Kleineidam
0b0e21f4fe Updated installation docs
[ci skip]
2014-04-24 19:42:50 +02:00
Bastian Kleineidam
cb6000ebe4 Updated website version
[ci skip]
2014-04-23 23:04:16 +02:00
Bastian Kleineidam
186bb73ede Set release date.
[ci skip]
2014-04-23 22:18:29 +02:00
Bastian Kleineidam
25835bd5ee Fix download link.
[ci skip]
2014-04-23 22:17:39 +02:00
Bastian Kleineidam
b4e33368ca Remove old download template file. 2014-04-23 22:17:21 +02:00
Bastian Kleineidam
49721affa6 Upload source releases to pypi. 2014-04-23 22:05:31 +02:00
Bastian Kleineidam
981079c041 Support itemtype attribute parsing. 2014-04-23 22:03:20 +02:00
Bastian Kleineidam
485c7fafb6 Fix typo
[ci skip]
2014-04-14 19:51:35 +02:00
Bastian Kleineidam
ca9bb9a186 Fix pip install doc
[ci skip]
2014-04-14 19:46:24 +02:00
Bastian Kleineidam
4232b69633 Support <img> srcset attribute parsing. 2014-04-10 17:51:59 +02:00
Bastian Kleineidam
6caf654031 Parse Link: heaaders. 2014-04-10 17:50:55 +02:00
Bastian Kleineidam
08fbd891ef Do not check external robots.txt sitemaps. 2014-04-09 19:44:29 +02:00
Bastian Kleineidam
4b00166b2a Replace .xz with .gz 2014-03-31 12:09:56 +02:00
Bastian Kleineidam
48635ddff8 Added docs.
[ci skip]
2014-03-31 11:15:07 +02:00