Commit graph

1006 commits

Author SHA1 Message Date
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