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

GRASS GIS trac at osgeo.org
Sun Aug 9 05:20:39 EDT 2009


#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
Resolution:               |    Keywords:             
  Platform:  Unspecified  |         Cpu:  Unspecified
--------------------------+-------------------------------------------------
Comment (by hamish):

 Replying to [comment:6 neteler]:
 ...
 > This indicates to some extent HTML errors in the original as well as
 Sphinx problems with the tags
 > {{{
 > <dt> ...
 > <dd> ...
 > }}}
 >
 > So with some effort the HTML pages could be made Sphinx compliant
 (perfect power user job).
 >
 > Here the list of failing HTML files in 6.5.svn: d.graph.rst, d.his.rst,
 d.linegraph.rst, d.mapgraph.rst, d.menu.rst, d.out.file.rst,
 d.text.freetype.rst, g.gisenv.rst, g.message.rst, grass6.rst,
 g.region.rst, i.ortho.photo.rst, m.proj.rst, ps.map.rst, r.category.rst,
 r.coin.rst, r.cost.rst, r.distance.rst, r.in.gdal.rst, r.in.xyz.rst,
 r.mfilter.fp.rst, r.mfilter.rst, r.out.gdal.rst, r.proj.rst, r.ros.rst,
 r.spreadpath.rst, r.spread.rst, r.terraflow.rst, r.tileset.rst,
 r.watershed.rst, r.what.rst, v.label.rst, v.lidar.correction.rst,
 v.lidar.edgedetection.rst, v.lidar.growing.rst, v.outlier.rst,
 v.reclass.rst, v.segment.rst, v.surf.bspline.rst.

 all of the above should (now) be html bug-free, as checked by dillo's lint
 verifier.

 if that is so and all is valid HTML, remaining problems should are for the
 sphinx people to fix IMO.

 > I've put everything online give you an impression (yes,
 > partially messy but not so bad...):
 > http://grass.osgeo.org/grass65/manuals/sphinx/

 specifically, bolds and newlines need work.


 Hamish

 ps- reST is good stuff.

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


More information about the grass-dev mailing list