[GRASS-dev] Re: [GRASS GIS] #151: make documentation be full text
searchable: use sphinx
GRASS GIS
trac at osgeo.org
Tue May 3 16:34:47 EDT 2011
#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 hamish):
Hi,
after extensive use of reST + sphinx for the osgeo LiveDVD*
(live.osgeo.org) documentation and website over the last year+, I am now
of the opinion that GRASS's current html-source man pages are far superior
to what would be accomplished by reST-source man pages; both in terms of
expressibility and aggravation. The critical thing is to get it into a
stable mark-up language, once there there's little reason (besides the
usual bugs) why html2rest or some any2pdf style program couldn't translate
between them and make a search index. Maybe wikimedia is a bit easier
markup language than html, but if you are reading this you are highly
likely to be smart enough to learn that <b> means bold and we don't
actually do much complicated with it. I think we forget how simple stock
HTML really is, and that when it comes to documentation, the steak is much
more important than the sizzle.
[*] https://trac.osgeo.org/osgeo/browser/livedvd/gisvm/trunk/doc/
best,
Hamish
--
Ticket URL: <https://trac.osgeo.org/grass/ticket/151#comment:13>
GRASS GIS <http://grass.osgeo.org>
More information about the grass-dev
mailing list