Mercurial > p > roundup > code
changeset 7962:828f79ae965b
doc: update links and docs on checking links
Add timeout for link checking so make linkcheck completes.
Document grep command to use to filter broken links to external links.
Fix PostgreSQL links to point to current pages.
Fix pyreadline3 link.
Fix vim po file plugin link
Use wayback machine for zpi internationalization link.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 13 May 2024 18:42:26 -0400 |
| parents | 32ead43b8299 |
| children | 05ce472d372b |
| files | RELEASE.txt doc/admin_guide.txt doc/developers.txt website/www/conf.py |
| diffstat | 4 files changed, 16 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/RELEASE.txt Mon May 13 13:32:02 2024 -0400 +++ b/RELEASE.txt Mon May 13 18:42:26 2024 -0400 @@ -56,6 +56,14 @@ fix broken references in docs verify redirects are correct + Use:: + + grep '\[broken\]\s*htt' _tmp/linkcheck/output.txt + + to find external refs only. Internal refs will probably fail + because they don't use :ref: or :doc: roles to reference them. + They are referenced using html link syntax. + 5. Update setup.py info if needed (contacts, classifiers, etc.). When releasing check that Development Status matches release: stable, beta alpha etc.
--- a/doc/admin_guide.txt Mon May 13 13:32:02 2024 -0400 +++ b/doc/admin_guide.txt Mon May 13 18:42:26 2024 -0400 @@ -583,7 +583,7 @@ to_tsquery. It is enabled by starting the search phrase with ``ts:``. .. _Parsing Queries: \ - https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES + https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES Websearch provides a more natural style of search and supports: @@ -641,7 +641,7 @@ exist``. .. _own textsearch configuration: \ - https://www.postgresql.org/docs/14/textsearch-configuration.html + https://www.postgresql.org/docs/current/textsearch-configuration.html It may be possible to append to this list using the tracker's interfaces.py. For details, see ``test/test_indexer.py`` in the @@ -1457,8 +1457,8 @@ installation uses libedit (macs), it should be possible to persistently set the history size using ``history size 10``. Pyreadline3 can set history length using -``history_length(10)``. See the older documentation for example syntax: -https://pythonhosted.org/pyreadline/usage.html.persistently. +``history_length(10)``. See the documentation for example syntax: +https://pythonhosted.org/pyreadline/usage.html#configuration-file. History is saved to the file ``.roundup_admin_history`` in your home directory (for windows usually ``\Users\<username>``.
--- a/doc/developers.txt Mon May 13 13:32:02 2024 -0400 +++ b/doc/developers.txt Mon May 13 18:42:26 2024 -0400 @@ -664,7 +664,7 @@ .. _Plural Forms: https://www.gnu.org/savannah-checkouts/gnu/gettext/manual/gettext.html .. _po filetype plugin: - https://vim.sourceforge.io/scripts/script.php?script_id=695 + https://www.vim.org/scripts/script.php?script_id=64 .. _PO utilities: https://github.com/pinard/po-utils .. _poEdit: https://poedit.net/ .. _pology: http://pology.nedohodnik.net/doc/user/en_US/ch-poformat.html @@ -685,4 +685,4 @@ https://pagetemplates.readthedocs.io/en/latest/history/TALESSpecification13.html .. _TravisCI: https://app.travis-ci.com/github/roundup-tracker/roundup .. _vim: https://www.vim.org/ -.. _ZPTInternationalization: http://grok.zope.org/doc/community/view_generation/i18n_of_your_app.html +.. _ZPTInternationalization: https://web.archive.org/web/20120804003011/http://grok.zope.org/doc/community/view_generation/i18n_of_your_app.html
--- a/website/www/conf.py Mon May 13 13:32:02 2024 -0400 +++ b/website/www/conf.py Mon May 13 18:42:26 2024 -0400 @@ -246,3 +246,5 @@ r'https://.../rest/.*', # dummy example url r'http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture/ZPTInternationalizationSupport', # dead link, there for historic ] + +linkcheck_timeout = 10 # seconds