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

GRASS GIS trac at osgeo.org
Mon Aug 13 06:32:51 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 lucadelu):

 In r52658 I added a first implementation of reStructuredText documentation
 for grass7. It uses the --rest-description flag and the
 [http://johnmacfarlane.net/pandoc/ pandoc] software.[[BR]]
 You can simple run
  run make restdocs
  cd dist.XXXX/doc/rest
  make html
 to create the documentation in rest format and to convert to beautiful
 HTML using sphinx. There are some issues still open, in order of
 importance level (if someone with good skill in makefile system wants to
 help me it would be really appreciated):
  * launching only "make", the reStructuredText documentation should not be
 created  but some documents are created;
  * I cannot convert helptext.html and wxgui documentation due to some Make
  * There are some documents with bad indentation because "pandoc" wrongs
 to convert <br> tag, the solution should be: remove white space if second
 character is not another white space, but some problem could remain ;
  * Some other problems remain (special chars, formatting) in the new rest

 Once solved, the resulting HTML pages could replace the current manual
 pages (since also search is provided).

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

More information about the grass-dev mailing list