Closed FroggyFlox closed 4 years ago
@FroggyFlox Thanks. I hadn't realised there was a link checker in Sphinx. We should pop that in our backend test prior to publishing so we can make sure we don't add any as we go along.
Good idea!
I didn't know about it either and came across it while trying to find a useful rst linter compatible with Sphinx (I was unsuccessful at that one, unfortunately). make checklink
definitely is a useful check before merging PR.
In extension to #235 , we seem to have several broken links in our documentation (external links). Indeed, the Sphinx built-in link checker
linkcheck
reports 25 broken links, not all of them covered by #235.See the full list below for details:
Full make linkcheck output
``` # make linkcheck Running Sphinx v3.1.2 making output directory... done loading pickled environment... done building [mo]: targets for 0 po files that are out of date building [linkcheck]: targets for 62 source files that are out of date updating environment: 0 added, 1 changed, 0 removed reading sources... [100%] network looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 1%] afp/apple_filing_protocol (line 24) ok https://support.apple.com/en-us/HT202784 (line 12) redirect https://support.apple.com/en-gb/HT204445 - permanently to https://support.apple.com/en-gb/guide/mac-help/mh17131/mac writing output... [ 3%] analytics (line 7) redirect http://forum.rockstor.com/ - permanently to https://forum.rockstor.com/ writing output... [ 4%] benchmarks writing output... [ 6%] clients writing output... [ 8%] concepts (line 75) ok https://www.docker.com/ writing output... [ 9%] config_backup/config_backup (line 9) redirect http://forum.rockstor.com/ - permanently to https://forum.rockstor.com/ writing output... [ 11%] contribute (line 52) redirect http://git-scm.com/ - permanently to https://git-scm.com/ (line 47) ok https://github.com/rockstor/rockstor-core (line 47) broken https://github.com/rockstor/rockstor-core#fork-destination-box - Anchor 'fork-destination-box' not found (line 41) redirect http://forum.rockstor.com - permanently to https://forum.rockstor.com/ (line 16) redirect http://forum.rockstor.com - permanently to https://forum.rockstor.com/ (line 62) broken https://github.com/organizations/rockstor/dashboard/issues - 404 Client Error: Not Found for url: https://github.com/organizations/rockstor/dashboard/issues (line 52) ok https://github.com/rockstor (line 84) ok https://github.com/ (line 68) redirect https://help.github.com/articles/using-pull-requests - permanently to https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-re quests (line 166) ok https://github.com/rockstor/rockstor-core/blob/master/AUTHORS (line 93) ok https://www.youtube.com/watch?v=51lGCTgqE_w (line 173) ok https://www.virtualbox.org/ (line 127) ok https://github.com/rockstor/rockstor-core/issues (line 177) ok https://www.youtube.com/watch?v=00k_RwwC5Ms (line 301) ok https://github.com/rockstor/rockstor-jslibs (line 179) ok https://virt-manager.org (line 278) broken https://developer.chrome.com/devtools/docs/dom-and-styles#inspecting-elements - Anchor 'inspecting-elements' not found (line 314) redirect http://www.postgresql.org/ - permanently to https://www.postgresql.org/ (line 320) redirect http://south.aeracode.org/ - with Found to https://south.aeracode.org/ (line 370) redirect https://ariejan.net/2011/07/05/git-squash-your-latests-commits-into-one/ - permanently to https://www.devroom.io/2011/07/05/git-squash-your-latests-commits-into- one/ writing output... [ 12%] contribute_documentation (line 101) redirect http://www.sphinx-doc.org - with Found to https://www.sphinx-doc.org/en/master/ (line 96) ok https://github.com/rockstor/rockstor-doc/blob/master/AUTHORS (line 111) redirect http://www.sphinx-doc.org/en/master/# - with Found to https://www.sphinx-doc.org/en/master/ (line 46) ok https://github.com/rockstor/rockstor-doc/issues (line 17) ok https://github.com/rockstor/rockstor-doc (line 117) ok https://pypi.org/project/sphinxcontrib-fulltoc/ (line 111) redirect http://www.sphinx-doc.org/en/master/usage/installation.html - with Found to https://www.sphinx-doc.org/en/master/usage/installation.html (line 179) redirect https://help.github.com/articles/closing-issues-using-keywords/ - permanently to https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-re quest-to-an-issue (line 152) broken http://localhost:8000 - HTTPConnectionPool(host='localhost', port=8000): Max retries exceeded with url: / (Caused by NewConnectionError('