[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:               |    Platform:  Unspecified
      Cpu:  Unspecified  |  
-------------------------+--------------------------------------------------

Comment(by wenzeslaus):

 Replying to [comment:38 timmie]:
 > So where are we now?

 I'm interested too, the last commit linked here is a revert (r53240).

 > Keeping the HTML docs are apparently the consence

 Of course, this is the format how it is stored and the resulting pages can
 be even using some JavaScript or some additional processing during
 compilation (this wasn't really explored so far).

 > The current doc are not searchable

 Using Sphinx would be a nice workaround to get time to solve our custom
 search.

 > So can we user the technology behind the Sphinx search be used for
 GRASS?

 Wouldn't this be much harder than using Sphinx and our HTML together?
 Sphinx can still be better for Python developers while HTML would be for
 other users?

 I guess that using Sphinx parts would be more difficult than using some
 standalone package (but really just guessing).

 > What about other approaches like Whoosh?

 And what about some JavaScript solutions at least for keywords, labels,
 descriptions and names?

 >
 > Ideally, the search would be on the website but also in the wxGui.

 There is a different search in the wxGUI in ''Layer Manager'', ''Search
 modules'' tab. You can search the module according to keywords, label,
 description and name (all at once). To get the documentation you currently
 have to open the module dialog/form and go to ''Manual'' tab. Better way
 would be to open manual page directly from the ''Search modules'' tab.
 Similar think is implemented in the extension manager/addons installer.
 And to the searchable manual pages in GU, I'm not sure what would be the
 easiest way to implement this.

 ''PS: `[1]` is interpreted by Trac as changeset link while
 `[http://abc.org Abc]` is interpreted as link with text. And note that
 Trac syntax for bullet lists is "space-star-space":''
 {{{
  * dsd
  * sdsasd
 }}}
 ''It would be really great to have http://trac.osgeo.org/osgeo/ticket/592
 solved, so we would see the live preview of the ticket (instead of
 pressing Preview button at the bottom of the page).''

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