Introduction/tutorial doc improvements. (#512)
authorMatt Renaud <matt@m-renaud.com>
Mon, 29 Jan 2018 16:39:58 +0000 (08:39 -0800)
committerGitHub <noreply@github.com>
Mon, 29 Jan 2018 16:39:58 +0000 (08:39 -0800)
commit743b17d16dc9f1b3aaea72d473176499db9a916d
tree614549c726695cff921aa702c590369d4037bf17
parent374d1c9887746efe98a08ef6a7abc7967ff513e1
Introduction/tutorial doc improvements. (#512)

Changes:
--------

- Update titles so that package name is visible in browser tabs
- Fix typo in sequence docs
- Use https://github.com/m-renaud/haddock-autolink
- Update theme (dark grey with green) for desktop and mobile

Why use a submodule?
--------------------

Improvements to the autolinker don't need to take place in the containers repo. Also, if other projects end up using it the code doesn't get out of sync (not everyone needs to copy/paste the Sphinx extension).

If you're not modifying the docs you don't need to pull down all the Python code. If you do want to build the container docs locally you need to pull down the submodule code (see the CONTRIBUTING.md file for exact commands to run).

Read the docs natively supports submodules so this has no visible effect on the docs.

[ci skip]
14 files changed:
.gitmodules [new file with mode: 0644]
CONTRIBUTING.md
docs/_extensions/HaddockAutolinker.py [deleted file]
docs/_extensions/haddock-autolink [new submodule]
docs/_extensions/haddock-autolink.py [deleted file]
docs/_extensions/hs-theme.py [new file with mode: 0644]
docs/_static/css/hs-theme.css [new file with mode: 0644]
docs/_static/images/favicon-green-16x16.png [new file with mode: 0644]
docs/_static/images/haskell-logo-green.svg [new file with mode: 0644]
docs/_templates/layout.html
docs/conf.py
docs/index.rst
docs/intro.rst
docs/sequence.rst