switch doc to User Guide style (based on RTD)

- fix #43
- use RTD theme & update conf.py
- update custom.css
- update travis (install RTD theme and also build 3.6-3.8 and take the
  docs from the 3.8 build)
- update CHANGELOG
- add @lilyminium to AUTHORS and authors in conf.py

Author: lilyminium

.travis.yml

@@ -1,8 +1,10 @@
+version: ~> 1.0
 language: python
 cache: pip
-sudo: false
 
 python:
+  - "3.8"
+  - "3.7"
   - "3.6"
   - "2.7"
 
@@ -11,17 +13,17 @@ branches:
     - master
 
 install:
-  - if [[ $TRAVIS_PYTHON_VERSION == "3.6" ]]; then pip install --upgrade sphinx sphinx-sitemap; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == "3.8" ]]; then pip install --upgrade sphinx sphinx-sitemap sphinx-rtd-theme; fi
   - pip install --upgrade pytest pytest-pep8 pytest-cov pytest-mock codecov
   - pip install -e .
 
 script:
   - pytest -v --cov MDAnalysisData MDAnalysisData 
 
 after_success:
-  # only need to build docs on 3.6 version
+  # only need to build docs on latest version
   # touch .nojekyll else github-pages messes up theme
-  - if [[ $TRAVIS_PYTHON_VERSION == "3.6" ]]; then python setup.py build_sphinx && touch ./build/sphinx/html/.nojekyll; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == "3.8" ]]; then python setup.py build_sphinx && touch ./build/sphinx/html/.nojekyll; fi
   - codecov
 
 deploy:
@@ -32,6 +34,6 @@ deploy:
   github_token: $GITHUB_TOKEN
   on:
     branch: master
-    python: "3.6"
+    python: "3.8"
   local_dir: build/sphinx/html
   project_name: MDAnalysisData

AUTHORS

@@ -10,3 +10,6 @@ addresses are all optional.
    - Shujie Fan @VOD555
    - Micaela Matta @micaela-matta
    - Richard J. Gowers @richardjgowers
+
+2020
+   - Lily Wang @lilyminium

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.1] - YYYY-MM-DD
+
+### Changes
+- update online docs theme (#43)
+
 ## [0.8.0] - 2019-08-13
 
 ### Added

docs/_static/custom.css

@@ -1,12 +1,14 @@
-/* override css for readable.css */
+/* custom MDAnalysis styling (User Guide theme) */
 
-/*  styles/fonts to match http://mdanalysis.org (see public/css) */
+/* See https://github.com/MDAnalysis/mdanalysis/wiki/MDAnalysis-theme-colours */
 /* MDAnalysis orange: #FF9200 */
 /* MDAnalysis gray: #808080 */
 /* MDAnalysis white: #FFFFFF */
 /* MDAnalysis black: #000000 */
-
-@import url('readable.css');
+/* Darker orange: e76900 */
+/* Even darker orange: #a24900 */
+/* RTD dark grey: #343131 */
+/* RTD light grey: #e6e6e6 */
 
 /* -- page layout --------------------------------------------------------- */
 
@@ -20,27 +22,53 @@ div.body {
 }
 
 div.sphinxsidebar a:hover {
-    color: #FF9200;
+    text-decoration: none !important;
 }
 
 div.sphinxsidebar p {
     color: #808080;
 }
 
+/* Home MDAnalysis colour */
+.wy-side-nav-search > a {
+    color: #343131;
+}
+
+/* Side MDAnalysis version colour */
+.wy-side-nav-search > div.version {
+    color: #808080;
+}
+
+/* Menubar caption colour */
+div.wy-menu-vertical span.caption-text {
+    color: #FF9200;
+}
+
+/* Mobile layout menubar option */
+nav.wy-nav-top {
+    background: #343131;
+}
+
+/* Menu search bar outline (default blue) */
+.wy-side-nav-search input[type="text"] {
+    border-color: #808080;
+}
+
 
 /* -- body styles --------------------------------------------------------- */
 
-a {
+/* Different coloured links for sidebar vs body) */
+div.rst-content a {
     color: #FF9200;
     text-decoration: none;
 }
 
-a:visited {
+div.rst-content a:visited {
     color: #FF9200;
 }
 
 a:hover {
-    color: #FF9200;
+    color: #FF9200 !important;
     text-decoration: underline;
 }
 
@@ -66,6 +94,7 @@ a.headerlink:hover {
     color: #fff;
 }
 
+/* ------- admonition boxes ------- */
 
 div.admonition {
     margin: 10px 0px;
@@ -75,4 +104,103 @@ div.admonition {
 div.admonition p.admonition-title {
     font-size: 100%;
     font-weight: bolder;
-}
+}
+
+/* ----- Tables ----- */
+
+/* override table width restrictions */
+/* wrap tables instead of scrolling */
+@media screen and (min-width: 767px) {
+
+    .wy-table-responsive table td, .wy-table-responsive table th {
+       /* !important prevents the common CSS stylesheets from overriding
+          this as on RTD they are loaded after this stylesheet */
+       white-space: normal !important;
+    }
+ 
+    .wy-table-responsive {
+       overflow: visible !important;
+       max-width: 100% !important;
+    }
+ }
+
+/* ----- Field lists ------ */
+
+.section > dl.field-list {
+    display: flex;
+    flex-wrap: wrap;
+    margin: 0;
+    padding: 0;
+}
+
+dl.field-list > dt::after {
+    content: ":";
+}
+
+.rst-content dl:not(.docutils) dt {
+    background: none;
+    color: #000000;
+    border-top: none;
+}
+
+.section > dl.field-list dt {
+    margin: 0;
+    padding: 0;
+    flex-basis: 20%;
+    display: block;
+}
+
+.section > dl.field-list > dd {
+    flex-basis: 70%;
+    margin: 0;
+}
+
+.section > dl.field-list > dd p {
+    margin: 0;
+}
+
+/* ----- MDAnalysis coloured elements ------ */
+
+.rst-content dl.class dt, .rst-content dl.function dt {
+    color: #ca6500;
+    background: #FFEBD0;
+    border-top: solid 3px #FF9200;
+}
+
+.rst-content .viewcode-link, .rst-content .viewcode-back {
+    color: #808080;
+}
+
+.rst-content .guilabel {
+    background: #efefef;
+    border: 1px solid #808080;
+}
+
+
+.rst-content .seealso p.admonition-title {
+    background: #808080;
+}
+
+.rst-content .seealso {
+    background: #e3e3e3;
+}
+
+.rst-content  .error p.admonition-title, .rst-content  .warning p.admonition-title {
+    background: #F45F4B;
+}
+
+.rst-content .error, .rst-content .warning {
+    background: #FFEEED;
+}
+
+.rst-content .caution p.admonition-title, .rst-content .note p.admonition-title, .rst-content .important p.admonition-title  {
+    background: #FF9200;
+}
+
+.rst-content .caution, .rst-content .note, .rst-content .important {
+    background: #FFEBD0;
+}
+
+.rst-content code:not(.xref).literal {
+    color: #ca6500;
+}