Add sphinx documentation

Add a docs/ subfolder with a sphinx documentation page which uses the readthedocstheme. I have copied the documentation from the GHC user guide and removed all references which belong to the documentation of GHC, e.g. options for specifying directories where GHC puts the .tix files.

Fixes #5 (closed)

added 3 commits

• a15cfd3c - Add about.rst
• 3d52a8b2 - Move example to examples.rst
• 5eebaf3b - Update README.md with information about the docs

Compare with previous version

approved this merge request

added 2 commits

• 83e56d29 - Remove parts of documentation which belong to GHC
• 31935c55 - Reorganize order of documentation

Compare with previous version

marked this merge request as ready

changed the description

added 14 commits

• 31935c55...20f5d124 - 5 commits from branch master
• e291c360 - Add initial sphinx template generated from sphinx-quickstart with read-the-docs theme
• cd207450 - Add .gitignore to docs/ subdirectory
• 27298bff - Copy the hpc documentation from the GHC user guide to the docs/ subdirectory
• 3b48e21f - Modify conf.py file to use sphinx_rtd_theme
• dbda721d - Add about.rst
• b5457e07 - Move example to examples.rst
• f24ff946 - Update README.md with information about the docs
• 3cd6b432 - Remove parts of documentation which belong to GHC
• dd63cc77 - Reorganize order of documentation

Compare with previous version

added Documentation label

requested review from @agustinmista

This looks good to me, though I don't have much (if any) experience with Sphinx, perhaps @Tritlo knows a bit more?

I don't have a lot of experience with Sphinx documentation either. I just observed that the majority of the Haskell tools (GHC, stack, cabal, alex, haddock etc.) are documented using sphinx with the readthedocs style. So the documentation looks somewhat familiar to Haskell users :)

Fair enough. I think we can go ahead and merge this then :D

approved this merge request

merged