Opened 8 years ago

Closed 7 weeks ago

Last modified 6 weeks ago

#982 closed enhancement (fixed)

Upgrade sphinx environment to support linkcheck build goal

Reported by: fgdrf Owned by: live-demo@…
Priority: normal Milestone: OSGeoLive14.0
Component: Documentation Keywords: docs, sphinx
Cc:

Description

To continuously check the external links in sphinx docs the build goal linkcheck should run every time the sphinx-build has been started (see root/livedvd/gisvm/trunk/bin/install_main_docs.sh).

linkcheck is available since version 1.1 of sphinx and check references, which can be configured by set up a ignore list, for example localhost URL's (see linkcheck_ignore config option).

This would help to avoid outdated references to external resources.

Change history (12)

comment:1 Changed 7 years ago by hamish

Milestone: OSGeoLive8.0

comment:2 Changed 6 years ago by hamish

Keywords: docs added; doc removed
Milestone: OSGeoLive8.0OSGeoLive8.5

comment:3 Changed 6 years ago by kalxas

Milestone: OSGeoLive8.5OSGeoLive9.0

comment:4 Changed 5 years ago by kalxas

Milestone: OSGeoLive9.0OSGeoLive9.5

Ticket retargeted after milestone closed

comment:5 Changed 4 years ago by kalxas

Milestone: OSGeoLive9.5OSGeoLive10.0

Ticket retargeted after milestone closed

comment:6 Changed 4 years ago by kalxas

Milestone: OSGeoLive10.0OSGeoLive10.5

comment:7 Changed 3 years ago by kalxas

Milestone: OSGeoLive10.5OSGeoLive11.0

Ticket retargeted after milestone closed

comment:8 Changed 2 years ago by darkblueb

Component: OSGeoLiveDocumentation

comment:9 Changed 8 months ago by cvvergara

Adding the link checker Many links are broken some are redirections. https://travis-ci.org/github/cvvergara/OSGeoLive-doc/builds/667128348

Pending tasks before making the PR In English documentation

  • fix redirections
  • fix broken links

In other languages documentation

  • update the locale
  • push to transifex
  • pull the newly untranslated strings (strings with the links will be consider untranslated by transifex but will be 99% similar to a suggestion)

comment:10 Changed 7 months ago by cvvergara

Most of the work is done, The current problem to fix is:

have travis pass the job that checks links

  • its failing because it is trying to deploy and that build is not for deployment

comment:11 Changed 7 weeks ago by cvvergara

Resolution: fixed
Status: newclosed

I prepared actions based on the (last) commit message The commit message must have the language code for example [de] updating translations will trigger the German translation link checks.

English is always checked. Because sometimes the link in English fails, which makes the translation fail also. So it can still be merged, but in another PR the English link should be fixed.

comment:12 Changed 6 weeks ago by cvvergara

Milestone: OSGeoLive11.0OSGeoLive14.0
Note: See TracTickets for help on using tickets.