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

[GRASS GIS]

#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 neteler):

 New URL:
 https://bitbucket.org/djerdo/musette/src/tip/musette/html/html2rest.py

-- 
Ticket URL: 
GRASS GIS 

___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

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

[GRASS GIS]

#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):

 i.e. to say, I'd rather invest the time in helping to debug htDig.

-- 
Ticket URL: 
GRASS GIS 

___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

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

[GRASS GIS]

#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  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: 
GRASS GIS 

___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

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

[GRASS GIS]

#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 martinl):

 Please follow wiki page
 http://grass.osgeo.org/wiki/Man_Pages_Improvement_Sprint

-- 
Ticket URL: 
GRASS GIS 

___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

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

[GRASS GIS]

#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 neteler):

 Came across another HTML to reST (Sphinx) converter:

 http://johnmacfarlane.net/pandoc/

 Online try (throw in GRASS HTML file):
 http://johnmacfarlane.net/pandoc/try

-- 
Ticket URL: 
GRASS GIS 
___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

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

[GRASS GIS]

#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):

 FWIW, reStructuredText (reST) docs:
 http://docutils.sourceforge.net/rst.html

-- 
Ticket URL: 
GRASS GIS 
___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

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

[GRASS GIS]

#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 neteler):

 If HTML is bugfree then it depends on
 http://bazaar.launchpad.net/~grflanagan/python-
 rattlebag/trunk/annotate/head:/src/html2rest.py which perhaps needs some
 tweaks to write clean reST.

-- 
Ticket URL: 
GRASS GIS 
___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

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

[GRASS GIS]

#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
 > {{{
 >  ...
 >  ...
 > }}}
 >
 > 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: 
GRASS GIS 
___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

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

[GRASS GIS]

#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 neteler):

 Here the procedure:

 {{{
 cd dist.x86_64-unknown-linux-gnu/docs/html/

 # convert HTML to rEST:
 mkdir rst
 cd rst
 for i in ../*.html ; do echo "$i:"; html2rest.py < $i > `basename $i
 .html`.rst ; done

 sphinx-quickstart

 # to avoid name conflict or define better in sphinx-quickstart:
 mv index.rst oldindex.rst
 mv *.rst source/

 # convert with sphinx
 make html
 }}}

 The resulting Sphinx-HTML manual is stored in the build/ directory.

 Markus

 PS: once the Wiki is back this should go there

-- 
Ticket URL: 
GRASS GIS 
___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

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

[GRASS GIS]

#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 neteler):

 I have locally converted '''most''' pages (using html2rest.py by Gerard
 Flanagan at http://bazaar.launchpad.net/~grflanagan/python-
 rattlebag/trunk/annotate/head:/src/html2rest.py ), a set of the GRASS HTML
 files fails with problems like
 {{{
 reST markup error:
 /home/neteler/grass65/dist.x86_64-unknown-linux-
 gnu/docs/html/rst/source/r.coin.rst:66: (SEVERE/4) Title level
 inconsistent:

 :
 :
 make: *** [html] Error 1
 }}}

 or

 {{{
 reST markup error:
 /home/neteler/grass65/dist.x86_64-unknown-linux-
 gnu/docs/html/rst/source/r.cost.rst:183: (SEVERE/4) Title level
 inconsistent:

 Algorithm notes
 ```
 make: *** [html] Error 1
 }}}


 This indicates to some extent HTML errors in the original as well as
 Sphinx problems with the tags
 {{{
  ...
  ...
 }}}

 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.

 I've put everything online give you an impression (yes, partially messy
 but not so bad...):

 http://grass.osgeo.org/grass65/manuals/sphinx/

 Markus

-- 
Ticket URL: 
GRASS GIS 
___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

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

[GRASS GIS]

#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
--+-
Changes (by neteler):

  * summary:  make documentation be full text searchable => make
  documentation be full text searchable: use
  sphinx

-- 
Ticket URL: 
GRASS GIS 
___
grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev