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

GRASS GIS trac at osgeo.org
Wed Aug 29 00:56:07 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 neteler):

 Replying to [comment:32 glynn]:
 > 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

 While well defined, it is much easier and not that invasive to directly
 render the
 module parameters/flags descriptions in ReST.

 > IMHO, it's preferable to cluttering up the build system with ReST-
 specific features.

 A Makefile guru may well see that the current approach could be simplified
 (rather than ditched).

 The usage of Sphinx offers capabilities we cannot achieve in a different
 from the current HTML documentation. And the current HTML core pages will
 remain as before, just an additional output is rendered:

 HTML core page (as present) --+
 g.parser --> HTML --------.---+---> HTML as currently

 HTML core page (as present) --+
 g.parser --> REST ------------+---> pandoc ---> Sphinx ---> additional
                                                             HTML with

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

More information about the grass-dev mailing list