[GHC] #11021: Document best practices for bringing up Sphinx on Windows

[GHC]

#11021: Document best practices for bringing up Sphinx on Windows
-------------------------------------+-------------------------------------
        Reporter:  bgamari           |                Owner:  Phyx-
            Type:  task              |               Status:  patch
        Priority:  normal            |            Milestone:  8.0.1
       Component:  Documentation     |              Version:  7.11
      Resolution:                    |             Keywords:
Operating System:  Windows           |         Architecture:
                                     |  Unknown/Multiple
 Type of failure:  None/Unknown      |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):  Phab:D1408
       Wiki Page:                    |  Phab:D1417
-------------------------------------+-------------------------------------

Comment (by Tamar Christina <tamar@…>):

 In [changeset:"65f3c4c0a1304b8d00b46dc0e77ad93fc566ffb1/ghc"
 65f3c4c0/ghc]:
 {{{
 #!CommitTicketReference repository="ghc"
 revision="65f3c4c0a1304b8d00b46dc0e77ad93fc566ffb1"
 Change sphinx for documentation building on windows to the python3 version

 Summary:
 Python 3 seems to have fixed the long standing codepage issue with
 python on Windows. To be able to reliably build the documentation
 we should use the Python 3 version of Sphinx.

 See `https://docs.python.org/dev/whatsnew/3.3.html#codecs` and
 `https://bugs.python.org/issue13216`. Sphinx also supports Python 3.

 Oddly enough `python3-sphinx` is registered as `sphinx-build.exe`
 instead of `sphinx-build3.exe`, so the changes in `configure.ac` can
 be reverted.

 install with `pacman -S mingw-w64-$(uname -m)-python3-sphinx`

 Test Plan: ./validate

 Reviewers: austin, thomie, bgamari

 Reviewed By: bgamari

 Subscribers: erikd

 Differential Revision: https://phabricator.haskell.org/D1417

 GHC Trac Issues: #11021
 }}}

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/11021#comment:10>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler