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

GRASS GIS trac at osgeo.org
Sat Mar 4 10:08:09 PST 2017


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

 * milestone:  7.2.1 => 7.4.0


Comment:

 The current state:

 As mentioned above, the ''Modules'' tab supports search in keywords, names
 and descriptions. In trunk (for 7.4), there is also ''Advanced search''
 button which open G7:g.search.modules which is available since 7.2 and can
 do full text search in manual pages.

 Also, there is Google search on the main website which needs change from
 `http://` to `https://` and searches through the website and all
 documentation.

 https://grass.osgeo.org/documentation/search-engine

 Sphinx is used for Python documentation and has search (which has full
 text):

 https://grass.osgeo.org/grass72/manuals/libpython

 Doxygen is used for C documentation which also has its own search (which
 doesn't have full text):

 https://grass.osgeo.org/programming7

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



More information about the grass-dev mailing list