[Live-demo] [OSGeo] #982: Upgrade sphinx environment to support linkcheck build goal

OSGeo trac_osgeo at osgeo.org
Sat Aug 4 14:19:51 PDT 2012


#982: Upgrade sphinx environment to support linkcheck build goal
-------------------------+--------------------------------------------------
 Reporter:  fgdrf        |       Owner:  live-demo@…              
     Type:  enhancement  |      Status:  new                      
 Priority:  normal       |   Milestone:                           
Component:  LiveDVD      |    Keywords:  doc sphinx               
-------------------------+--------------------------------------------------
 To continuously check the external links in sphinx docs the build goal
 '''linkcheck''' should run every time the sphinx-build has been started
 (see [source:root/livedvd/gisvm/trunk/bin/install_main_docs.sh]).

 [http://sphinx.pocoo.org/latest/config.html#options-for-the-linkcheck-
 builder 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.

-- 
Ticket URL: <http://trac.osgeo.org/osgeo/ticket/982>
OSGeo <http://www.osgeo.org/>
OSGeo committee and general foundation issue tracker.


More information about the Osgeolive mailing list