[GHC] #14144: Standardize binary distribution doc files

[GHC]

#14144: Standardize binary distribution doc files
-------------------------------------+-------------------------------------
        Reporter:  patrickdoc        |                Owner:  (none)
            Type:  feature request   |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  Build System      |              Version:  8.2.1
      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 patrickdoc):

 I've worked through a number of these problems in Hadrian, and opened a PR
 for comments [https://github.com/snowleopard/hadrian/pull/413].

 Some more comments specifically about this ticket:

 Cabal's guide's configuration requires the "Read the Docs" theme.
 Packaging the theme inside the folder or requiring the user to install it
 both seem wrong to me, so it might be nice to have a default theme for
 local building. But that would have to be changed in the
 `cabal/Cabal/doc/conf.py` source.

 Building all of the docs on a single platform should be doable. However,
 the current implementation needs `package-data.mk` generated by `ghc-cabal
 configure`. This fails to configure `Win32` on Unix, and I would imagine
 the opposite is also true. However, I believe the data should be
 attainable just from the cabal file. I'll need to do some research to see
 if we can get by without `ghc-cabal` for the docs.

 I have managed to eliminate the need for `gen_contents_index`, which just
 leaves the mkDocs script. This script really just unifies the
 documentation built on both platforms, so solving the above would remove
 the need for this script. Likewise your upload script should become much
 simpler.

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