From b21fe8045a3474741c907fab654eba1b1dc8270e Mon Sep 17 00:00:00 2001 From: Steve Smith Date: Wed, 1 Apr 2015 10:17:58 -0400 Subject: [PATCH] Added workaround notes for CSS decode error --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0db44a1928b8..ffea540c382e 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,13 @@ Then run it from the root of the project with sphinx-autobuild docs docs/_build/html -Note that you may need to run 'make html' once before sphinx-autobuild will serve the docs correctly. +Note that you may need to run 'make html' once before sphinx-autobuild will serve the docs correctly. Also, there seems to be an encoding issue in one of the CSS files in the theme that may cause Python to throw an exception when trying to serve the file. You can work around this issue by editing the cp1252.py file (most likely in C:\Python34\Lib\encodings\ on Windows). Modify the IncrementalDecoder as follows: + + class IncrementalDecoder(codecs.IncrementalDecoder): + def decode(self, input, final=False): + return codecs.charmap_decode(input,'ignore',decoding_table)[0] + +This should allow the CSS file to be loaded, but may result in icons being rendered improperly. A proper fix will likely involve confirming the encoding used by the CSS file for the RTD theme. If contributing new documentation content, please review the [Sphinx Style Guide](http://documentation-style-guide-sphinx.readthedocs.org/en/latest/style-guide.html). @@ -58,4 +64,4 @@ In addition to the style guide, articles should be organized into logical groups **Note:** Sphinx will automatically fix duplicate image names, such as the about-page.png files shown above. There is no need to try to ensure uniqueness of static files beyond an individual article. -Author information should be placed in the _authors folder following the example of steve-smith.rst. Place photos in the photos folder - size them to be no more than 125px wide or tall. \ No newline at end of file +Author information should be placed in the _authors folder following the example of steve-smith.rst. Place photos in the photos folder - size them to be no more than 125px wide or tall.