Skip to content

Commit 1631952

Browse files
lilyminiumorbeckst
authored andcommitted
update documentation style with rtd_theme
- fix #80 - removed un-necessary stuff (readable.css, colors from conf.py) - add @lilyminium to authors
1 parent 85ad60e commit 1631952

6 files changed

Lines changed: 186 additions & 543 deletions

File tree

AUTHORS

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
gridDataFormats
33
=================
44

5-
Copyright (c) 2007-2019 Oliver Beckstein <orbeckst@gmail.com> and Contributors
5+
Copyright (c) 2007-2020 Oliver Beckstein <orbeckst@gmail.com> and Contributors
66

77
Published under the GNU Lesser General Public Licence, version 3
88

@@ -19,3 +19,4 @@ Contributors:
1919
* Giacomo Fiorin <giacomofiorin>
2020
* Eloy Félix <eloyfelix>
2121
* René Hafner (Hamburger) <renehamburger1993>
22+
* Lily Wang <lilyminium>

CHANGELOG

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ The rules for this file:
1313
* accompany each entry with github issue/PR number (Issue #xyz)
1414

1515
------------------------------------------------------------------------------
16-
??/??/2019 eloyfelix, renehamburger1993
16+
??/??/2019 eloyfelix, renehamburger1993, lilyminium
1717

1818
* 0.6.0
1919

2020
Enhancements
2121

2222
* Allow parsing/writing gzipped DX files
23-
24-
23+
* Update doc theme to use sphinx-rtd-theme (#80)
24+
2525
Fixes
26-
26+
2727
* fix initialization of mutable instance variable of Grid class (metadata dict) (#71)
2828
* fix multiple __init__ calls (#73)
2929

doc/source/_static/custom.css

Lines changed: 134 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@
55
/* MDAnalysis gray: #808080 */
66
/* MDAnalysis white: #FFFFFF */
77
/* MDAnalysis black: #000000 */
8-
9-
@import url('readable.css');
8+
/* Darker orange: e76900 */
9+
/* Even darker orange: #a24900 */
10+
/* RTD dark grey: #343131 */
11+
/* RTD light grey: #e6e6e6 */
1012

1113
/* -- page layout --------------------------------------------------------- */
1214

@@ -20,27 +22,53 @@ div.body {
2022
}
2123

2224
div.sphinxsidebar a:hover {
23-
color: #FF9200;
25+
text-decoration: none !important;
2426
}
2527

2628
div.sphinxsidebar p {
2729
color: #808080;
2830
}
2931

32+
/* Home MDAnalysis colour */
33+
.wy-side-nav-search > a {
34+
color: #343131;
35+
}
36+
37+
/* Side MDAnalysis version colour */
38+
.wy-side-nav-search > div.version {
39+
color: #808080;
40+
}
41+
42+
/* Menubar caption colour */
43+
div.wy-menu-vertical span.caption-text {
44+
color: #FF9200;
45+
}
46+
47+
/* Mobile layout menubar option */
48+
nav.wy-nav-top {
49+
background: #343131;
50+
}
51+
52+
/* Menu search bar outline (default blue) */
53+
.wy-side-nav-search input[type="text"] {
54+
border-color: #808080;
55+
}
56+
3057

3158
/* -- body styles --------------------------------------------------------- */
3259

33-
a {
60+
/* Different coloured links for sidebar vs body) */
61+
div.rst-content a {
3462
color: #FF9200;
3563
text-decoration: none;
3664
}
3765

38-
a:visited {
66+
div.rst-content a:visited {
3967
color: #FF9200;
4068
}
4169

4270
a:hover {
43-
color: #FF9200;
71+
color: #FF9200 !important;
4472
text-decoration: underline;
4573
}
4674

@@ -66,6 +94,7 @@ a.headerlink:hover {
6694
color: #fff;
6795
}
6896

97+
/* ------- admonition boxes ------- */
6998

7099
div.admonition {
71100
margin: 10px 0px;
@@ -75,4 +104,103 @@ div.admonition {
75104
div.admonition p.admonition-title {
76105
font-size: 100%;
77106
font-weight: bolder;
107+
}
108+
109+
/* ----- Tables ----- */
110+
111+
/* override table width restrictions */
112+
/* wrap tables instead of scrolling */
113+
@media screen and (min-width: 767px) {
114+
115+
.wy-table-responsive table td, .wy-table-responsive table th {
116+
/* !important prevents the common CSS stylesheets from overriding
117+
this as on RTD they are loaded after this stylesheet */
118+
white-space: normal !important;
119+
}
120+
121+
.wy-table-responsive {
122+
overflow: visible !important;
123+
max-width: 100% !important;
124+
}
125+
}
126+
127+
/* ----- Field lists ------ */
128+
129+
.section > dl.field-list {
130+
display: flex;
131+
flex-wrap: wrap;
132+
margin: 0;
133+
padding: 0;
134+
}
135+
136+
dl.field-list > dt::after {
137+
content: ":";
138+
}
139+
140+
.rst-content dl:not(.docutils) dt {
141+
background: none;
142+
color: #000000;
143+
border-top: none;
144+
}
145+
146+
.section > dl.field-list dt {
147+
margin: 0;
148+
padding: 0;
149+
flex-basis: 20%;
150+
display: block;
151+
}
152+
153+
.section > dl.field-list > dd {
154+
flex-basis: 70%;
155+
margin: 0;
156+
}
157+
158+
.section > dl.field-list > dd p {
159+
margin: 0;
160+
}
161+
162+
/* ----- MDAnalysis coloured elements ------ */
163+
164+
.rst-content dl.class dt, .rst-content dl.function dt {
165+
color: #ca6500;
166+
background: #FFEBD0;
167+
border-top: solid 3px #FF9200;
168+
}
169+
170+
.rst-content .viewcode-link, .rst-content .viewcode-back {
171+
color: #808080;
172+
}
173+
174+
.rst-content .guilabel {
175+
background: #efefef;
176+
border: 1px solid #808080;
177+
}
178+
179+
180+
.rst-content .seealso p.admonition-title {
181+
background: #808080;
182+
}
183+
184+
.rst-content .seealso {
185+
background: #e3e3e3;
186+
}
187+
188+
.rst-content .error p.admonition-title, .rst-content .warning p.admonition-title {
189+
background: #F45F4B;
190+
}
191+
192+
.rst-content .error, .rst-content .warning {
193+
background: #FFEEED;
194+
}
195+
196+
.rst-content .caution p.admonition-title, .rst-content .note p.admonition-title, .rst-content .important p.admonition-title {
197+
background: #FF9200;
198+
}
199+
200+
.rst-content .caution, .rst-content .note, .rst-content .important {
201+
background: #FFEBD0;
202+
}
203+
204+
.rst-content code:not(.xref).literal {
205+
color: #ca6500;
78206
}

0 commit comments

Comments
 (0)