Skip to content

Commit e71b969

Browse files
committed
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.
1 parent ffe8b6e commit e71b969

File tree

4 files changed

+16
-6
lines changed

4 files changed

+16
-6
lines changed

RELEASE.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,14 @@ Roundup release checklist:
5656
fix broken references in docs
5757
verify redirects are correct
5858

59+
Use::
60+
61+
grep '\[broken\]\s*htt' _tmp/linkcheck/output.txt
62+
63+
to find external refs only. Internal refs will probably fail
64+
because they don't use :ref: or :doc: roles to reference them.
65+
They are referenced using html link syntax.
66+
5967
5. Update setup.py info if needed (contacts, classifiers, etc.). When
6068
releasing check that Development Status matches release: stable,
6169
beta alpha etc.

doc/admin_guide.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -583,7 +583,7 @@ languages are supported.
583583
to_tsquery. It is enabled by starting the search phrase with ``ts:``.
584584

585585
.. _Parsing Queries: \
586-
https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES
586+
https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES
587587

588588
Websearch provides a more natural style of search and supports:
589589

@@ -641,7 +641,7 @@ You will see an error about ``text search configuration ... does not
641641
exist``.
642642

643643
.. _own textsearch configuration: \
644-
https://www.postgresql.org/docs/14/textsearch-configuration.html
644+
https://www.postgresql.org/docs/current/textsearch-configuration.html
645645

646646
It may be possible to append to this list using the tracker's
647647
interfaces.py. For details, see ``test/test_indexer.py`` in the
@@ -1457,8 +1457,8 @@ If you are using GNU readline, ``set history-size 10``. If your
14571457
installation uses libedit (macs), it should be possible to
14581458
persistently set the history size using ``history size
14591459
10``. Pyreadline3 can set history length using
1460-
``history_length(10)``. See the older documentation for example syntax:
1461-
https://pythonhosted.org/pyreadline/usage.html.persistently.
1460+
``history_length(10)``. See the documentation for example syntax:
1461+
https://pythonhosted.org/pyreadline/usage.html#configuration-file.
14621462

14631463
History is saved to the file ``.roundup_admin_history`` in your home
14641464
directory (for windows usually ``\Users\<username>``.

doc/developers.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -664,7 +664,7 @@ At run time, Roundup automatically compiles message catalogs whenever
664664
.. _Plural Forms:
665665
https://www.gnu.org/savannah-checkouts/gnu/gettext/manual/gettext.html
666666
.. _po filetype plugin:
667-
https://vim.sourceforge.io/scripts/script.php?script_id=695
667+
https://www.vim.org/scripts/script.php?script_id=64
668668
.. _PO utilities: https://github.com/pinard/po-utils
669669
.. _poEdit: https://poedit.net/
670670
.. _pology: http://pology.nedohodnik.net/doc/user/en_US/ch-poformat.html
@@ -685,4 +685,4 @@ At run time, Roundup automatically compiles message catalogs whenever
685685
https://pagetemplates.readthedocs.io/en/latest/history/TALESSpecification13.html
686686
.. _TravisCI: https://app.travis-ci.com/github/roundup-tracker/roundup
687687
.. _vim: https://www.vim.org/
688-
.. _ZPTInternationalization: http://grok.zope.org/doc/community/view_generation/i18n_of_your_app.html
688+
.. _ZPTInternationalization: https://web.archive.org/web/20120804003011/http://grok.zope.org/doc/community/view_generation/i18n_of_your_app.html

website/www/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,3 +246,5 @@
246246
r'https://.../rest/.*', # dummy example url
247247
r'http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture/ZPTInternationalizationSupport', # dead link, there for historic
248248
]
249+
250+
linkcheck_timeout = 10 # seconds

0 commit comments

Comments
 (0)