#11021: Document best practices for bringing up Sphinx on Windows -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new Priority: normal | Milestone: 8.0.1 Component: Documentation | Version: 7.11 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: | Unknown/Multiple Type of failure: None/Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): Wiki Page: | -------------------------------------+------------------------------------- Comment (by awson): To clarify what is written in the cited (my) e-mail: the problem with Windows console codepage 65001 is not Sphinx-specific but pervades the whole Python ecosystem. And Python people won't fix it. Thus the only way to happily build GHC documentation with Sphinx on Windows is to modify `mkUserGuidePart`. I've attached the cited patch as a separate file for convenience. Patch is very simple and basically tells handle I/O functions to expect `utf8`-encoded content. I didn't guard the changes to be Windows-specific because I think it is at least harmless on other systems and, perhaps, can help in some other peculiar configurations. Regarding Sphinx installation I believe the most "automated" way would be to add MSys2/MINGW Sphinx package as another MSys2/MINGW dependency, but this requires not only `configure.ac` modification but (most important) fixing MSys2/MINGW Sphinx package itself, which should better be upstreamed to MSys2/MINGW, and I have no time to do this ATM, sorry. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11021#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#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): Wiki Page: | ----------------------------------+---------------------------------------- Changes (by Phyx-): * owner: => Phyx- -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11021#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#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: | ----------------------------------+---------------------------------------- Comment (by Tamar Christina ): In [changeset:"6bef55c6b561080c5ddff73f2c501e40acee86ef/ghc" 6bef55c6/ghc]: {{{ #!CommitTicketReference repository="ghc" revision="6bef55c6b561080c5ddff73f2c501e40acee86ef" Fix documentation build on windows Summary: Fix building new Sphinx documenation on Windows in msys2 using Awson's patch on #11021. Install Sphinx using `pacman -S mingw-w64-$(uname -m)-python2-sphinx` Test Plan: Apply patch and ./validate Reviewers: thomie, bgamari, austin Reviewed By: thomie, bgamari Subscribers: erikd Differential Revision: https://phabricator.haskell.org/D1408 GHC Trac Issues: #11021 }}} -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11021#comment:5 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#11021: Document best practices for bringing up Sphinx on Windows ----------------------------------+---------------------------------------- Reporter: bgamari | Owner: Type: task | Status: new 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: | ----------------------------------+---------------------------------------- Changes (by Phyx-): * owner: Phyx- => * status: closed => new * resolution: fixed => Comment: Just ran into the codepage issue @awson mentioned. Worked the first validate but subsequent ones failed.. don't know why. In any case, the issue seems to be fixed in `python3` https://docs.python.org/dev/whatsnew/3.3.html#codecs and https://bugs.python.org/issue13216 Sphinx also has support for `python 3.3+` so I will make a patch to use the `python3` version of Sphinx and revalidate. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11021#comment:7 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#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 -------------------------------------+------------------------------------- Changes (by Phyx-): * owner: => Phyx- -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11021#comment:9 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler

#11021: Document best practices for bringing up Sphinx on Windows -------------------------------------+------------------------------------- Reporter: bgamari | Owner: Phyx- Type: task | Status: closed Priority: normal | Milestone: 8.0.1 Component: Documentation | Version: 7.11 Resolution: fixed | 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 -------------------------------------+------------------------------------- Changes (by Phyx-): * status: patch => closed * resolution: => fixed Comment: Should now be really fixed. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/11021#comment:11 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler