Luke Lau authored 4 years ago and Oleg Grenrus committed 4 years ago

Also fix some deprecated Sphinx stuff and update building documentation
to mention the virtualenv

Use a requirements file to specify sphinx version

Use the builtin python3 virtualenv

Saves one more dependency you need to install!
https://docs.python.org/3/tutorial/venv.html

- Fix Makefile to work on arch where we need to use sphinx-build2
- README: mention python 2 and use Makefile
- html output now properly links to github source
- new-freeze documentation fixed for the --project-file case

fixes #4833, #4834 [ci skip]

[ci skip]

This patch defines 3 short linkeners,

    extlinks = {
      'issue': ('https://github.com/haskell/cabal/issues/%s', '#'),
      'ghc-wiki': ('http://ghc.haskell.org/trac/ghc/wiki/%s', ''),
      'ghc-ticket': ('http://ghc.haskell.org/trac/ghc/ticket/%s', 'GHC #'),
    }

See http://www.sphinx-doc.org/en/stable/ext/extlinks.html for more
information as well as this diff for examples on how to use them.