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

GRASS GIS trac at osgeo.org
Sun Aug 19 13:41:52 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:31 wenzeslaus]:

 > Once module description is converted to HTML the information whether
 this description list is module parameter list or some general list in
 hand-written module description (module.html file) is lost.

 The output of the --interface-description switch has a well-defined
 format, so the relevant information can readily be extracted from the
 generated HTML file e.g. using a Python script based upon

 > The second one is to create a custom (context aware) transformation
 which uses both HTML markup and contents (e.g. contents of <h2> tag)

 This is what I'm proposing.

 > but this can be a lot of work (I've tried it using XSLT but I gave it

 IMHO, it's preferable to cluttering up the build system with ReST-specific
 features. The nroff manual pages are generated without requiring anything
 beyond one rule in Html.make and one in man/Makefile. An added advantage
 is that any errors which occur while generating them result in the
 corresponding module being listed in the error.log file.

 As it stands, I'm inclined to revert most of r52656 (other than the fixes
 to v.in.ogr.html, which should have been a separate commit). Also r52459,
 unless there's some other use for it.

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

More information about the grass-dev mailing list