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

[GRASS GIS]

#151: make documentation be full text searchable: use sphinx
-----------------------------------------+----------------------------------
 Reporter:  timmie                       |       Owner:  epatton    
     Type:  enhancement                  |      Status:  assigned   
 Priority:  major                        |   Milestone:  7.0.0      
Component:  Docs                         |     Version:  unspecified
 Keywords:  JavaScript, Sphinx, Website  |    Platform:  Unspecified
      Cpu:  Unspecified                  |  
-----------------------------------------+----------------------------------
Changes (by wenzeslaus):

  * keywords:  => JavaScript, Sphinx, Website


Comment:

 As I was saying, perhaps some JavaScript which would go through some JSON
 or XML file would be enough? Search could be graphically incorporated in
 the same way as TOC. The JSON/XML file would be generated during build and
 would contain name, label, description and keywords for each module. This
 wouldn't be full text but it is good enough. It works well (enough) in
 ''Search modules'' tab in wxGUI.

 This search could be attached to each page but there could be also a
 separate page. However, this wouldn't work so well I think (it would be
 less prominent). The file with the metadata would be quite large but with
 today's web and loading on demand it could work. Some special care would
 have to be done for the local pages.

 Somebody interested in some JavaScript development?

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