Hopiu/linkchecker
1
0
Fork 0
mirror of https://github.com/Hopiu/linkchecker.git synced 2026-05-05 21:24:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
7196 commits 1 branch 0 tags 24 MiB
Commit graph

1162 commits

Author SHA1 Message Date
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
c28559e0d9 Recommend ensurepip instead of get-pip.py 
Avoids manual download of the get-pip.py file.
 2021-12-15 19:34:24 +00:00
LinkChecker
7497f1aa63 Update man pages 2021-12-14 19:27:40 +00:00
LinkChecker
289ef5dc5b Update doc locale 2021-12-14 19:27: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
2cc1319bee GitHub release must be created before Python distribution files 
setuptools_scm will use the release tag.
 2021-12-06 19:40:14 +00:00
Chris Mayo
d2d2a563cc Make installing from the git archive of a tagged commit possible 
aka make GitHub release assets usable.

Requires setuptools-scm-git-archive.
 2021-12-06 19:40:02 +00:00
Chris Mayo
3b19680e97 Add guidance on character set detecting including cchardet 2021-12-06 19:24:26 +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
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
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