[GRASS-dev] [GRASS GIS] #151: make documentation be full text searchable: use sphinx

GRASS GIS trac at osgeo.org
Mon Aug 13 14:34:39 PDT 2012

#151: make documentation be full text searchable: use sphinx
 Reporter:  timmie       |       Owner:  epatton    
     Type:  enhancement  |      Status:  assigned   
 Priority:  major        |   Milestone:  7.0.0      
Component:  Website      |     Version:  unspecified
 Keywords:               |    Platform:  Unspecified
      Cpu:  Unspecified  |  

Comment(by hamish):

 Replying to [comment:17 lucadelu]:
 > Once solved, the resulting HTML pages could replace the current manual
 > pages (since also search is provided).

 erhm, once solved and building in parallel ''discussion'' on if that
 should happen could begin. Personally I am not in favour of throwing away
 all the strongly marked up work we have done in the description.html files
 in favour of the rather erratic and obscure markup of reSt for those
 pages. Perhaps 'finicky' is a better word. I'm happy to see the help pages
 get pretty, and yes reSt+sphinx-alikes is very pretty, but would like it
 to be in parallel, and reSt translated from our existing HTML docs
 automatically (ie the description.html parts), in the same way (or better)
 than the man pages are now.

 I don't think lack of a working htDig install*, or reliance on "site:"
 google search, is a fatal blow for html.

 [*] (is that still the case? if so as offered earlier, I'm happy to spend
 a little time on it)


Ticket URL: <https://trac.osgeo.org/grass/ticket/151#comment:18>
GRASS GIS <http://grass.osgeo.org>

More information about the grass-dev mailing list