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

GRASS GIS trac at osgeo.org
Wed Aug 15 13:09:51 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 glynn):

 Replying to [comment:26 neteler]:
 > > I don't see what problem this is trying to solve.
 > Besides a more modern look, it offers an included search engine for
 > the manual which even works offline in local GRASS GIS installations.

 First, bear in mind that an important function of the HTML files is as the
 source for Unix (nroff) manual pages. Anything which interferes with that
 isn't acceptable.

 Beyond that, I don't really see the point of adding another dependency. Or
 ReST, for that matter. The output from --html-description is only a
 fragment of the final HTML; the rest is in HTML, and that isn't going to
 change (HTML is far better known and supported than ReST).

 If you think that there are specific problems with the current HTML, the
 appropriate solution would be to change the parser-generated HTML and/or
 the guidelines for the manually-generated HTML.

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

More information about the grass-dev mailing list