#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 glynn):
Replying to [comment:33 neteler]:
> > The output of the --interface-description switch has a well-defined
format, so the relevant information can readily be extracted from the
generated HTML file e.g. using a Python script based upon
tools/g.html2man/html.py.
>
> While well defined, it is much easier and not that invasive to directly
render the
> module parameters/flags descriptions in ReST.
>
> > IMHO, it's preferable to cluttering up the build system with ReST-
specific features.
>
> A Makefile guru may well see that the current approach could be
simplified
> (rather than ditched).
The current approach mirrors the mechanism used to generate the HTML
files, which is significantly more involved than the mechanism used to
generate the manual pages from the completed HTML files. If we can
generate the ReST files directly from the completed HTML files (and
there's no fundamental reason why we can't), it would simplify the build
process somewhat.
In r52956, I've modified the --html-description output to make it easier
to parse (adding DIV tags around various sections) and added a script to
generate ReST output from the completed HTML pages.
--
Ticket URL: <https://trac.osgeo.org/grass/ticket/151#comment:35>
GRASS GIS <http://grass.osgeo.org>
_______________________________________________
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev
