Skip to content

Commit 53179ac

Browse files
committed
copied basic sphinx docs for MDA from MDAnalysis and PMDA
1 parent 95bc8ca commit 53179ac

7 files changed

Lines changed: 826 additions & 0 deletions

File tree

docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = MDAnalysisData
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/custom.css

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
/* override css for readable.css */
2+
3+
/* styles/fonts to match http://mdanalysis.org (see public/css) */
4+
/* MDAnalysis orange: #FF9200 */
5+
/* MDAnalysis gray: #808080 */
6+
/* MDAnalysis white: #FFFFFF */
7+
/* MDAnalysis black: #000000 */
8+
9+
@import url('readable.css');
10+
11+
/* -- page layout --------------------------------------------------------- */
12+
13+
body {
14+
font-family: 'PT Sans', Helvetica, Arial, 'sans-serif';
15+
font-size: 17px;
16+
}
17+
18+
div.body {
19+
color: #000000;
20+
}
21+
22+
div.sphinxsidebar a:hover {
23+
color: #FF9200;
24+
}
25+
26+
div.sphinxsidebar p {
27+
color: #808080;
28+
}
29+
30+
31+
/* -- body styles --------------------------------------------------------- */
32+
33+
a {
34+
color: #FF9200;
35+
text-decoration: none;
36+
}
37+
38+
a:visited {
39+
color: #FF9200;
40+
}
41+
42+
a:hover {
43+
color: #FF9200;
44+
text-decoration: underline;
45+
}
46+
47+
48+
pre, tt, code {
49+
font-family: Menlo, Monaco, 'Courier New', monospace
50+
}
51+
52+
53+
div.body h1 {
54+
font-weight: bolder;
55+
}
56+
57+
a.headerlink {
58+
color: #808080;
59+
font-size: 0.8em;
60+
padding: 0 4px 0 4px;
61+
text-decoration: none;
62+
}
63+
64+
a.headerlink:hover {
65+
background-color: #808080;
66+
color: #fff;
67+
}
68+
69+
70+
div.admonition {
71+
margin: 10px 0px;
72+
padding: 10px 10px;
73+
}
74+
75+
div.admonition p.admonition-title {
76+
font-size: 100%;
77+
font-weight: bolder;
78+
}

docs/_static/logos/AUTHOR

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
The MDAnalysis 'Atom' logo was created by Christian Beckstein and is
2+
3+
Copyright (c) 2011 Christian Beckstein
4+
5+
MDAnalysis Logo 'Atom' by Christian Beckstein is licensed under a
6+
Creative Commons Attribution-NoDerivs 3.0 Unported License.
7+
To view a copy of this license, visit
8+
http://creativecommons.org/licenses/by-nd/3.0/ or send a letter to Creative
9+
Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
10+
11+
The logo is contained in the file 'mdanalysis-logo.png'.
12+
13+
Derivatives in the files 'mdanalysis-logo-127x55.png',
14+
'mdanalysis-logo-200x150.png', 'mdanalysis-logo.ico' were created for
15+
inclusion in MDAnalysis and on websites related to MDAnalysis. They
16+
are distributed under the same license as the 'Atom' logo.
8.62 KB
Loading
4.44 KB
Binary file not shown.

0 commit comments

Comments
 (0)