[Live-demo] Re: [OSGeo] #896: sphinx doc build is broken because of BOM

OSGeo trac_osgeo at osgeo.org
Sun May 13 13:32:52 PDT 2012

#896: sphinx doc build is broken because of BOM
 Reporter:  fgdrf    |       Owner:  live-demo@…              
     Type:  defect   |      Status:  new                      
 Priority:  major    |   Milestone:                           
Component:  LiveDVD  |    Keywords:                           

Comment(by fgdrf):

 First of all, the sphinx doc build is still broken.  But nevertheless I
 agree whit you to harmonize all the file encodings.

 Sphinx assumes, if not configured at conf.py that all files are UTF-8
 sources (http://sphinx.pocoo.org/rest.html#source-encoding) , means both
 documentation (rst) and included files (e.g csv). The configuration value
 isn't set currently (`source-encoding`). So we should follow the defaults
 and should not mix between languages, nevertheless is necessitate or not.

 Got the build back working with the following steps (reverenced csv files
 were not correct, not the printed "sponsors.rst") :

 #1 `perl -CD -pe 'tr/\x{feff}//d' contributors.csv > xx;mv xx
 #1 edit the csv file with vi and typed `set fileencoding=utf-8`, saved and
 closed afterwards

 We should let this ticket still open because of mixed encodings (UTF-8,
 UTF-8 CRLF, "shell archive or script for antique kernel text", "ASCII
 text", "PARIX object not stripped", etc):

 To analyze the docs do execute in terminal:
 for f in `find . -name "*.rst"` ; do file $f ; done | grep -v target

Ticket URL: <http://trac.osgeo.org/osgeo/ticket/896#comment:3>
OSGeo <http://www.osgeo.org/>
OSGeo committee and general foundation issue tracker.

More information about the Osgeolive mailing list