Skip to content

Commit 95eaac5

Browse files
author
Nathan Lee
committed
Minor restructuring for better code readability. Added documentation.
1 parent fbb4e69 commit 95eaac5

60 files changed

Lines changed: 7571 additions & 177 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ dist
66
.eggs
77
*.egg-info
88
MANIFEST
9+
build

‎docs/404.html‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
<!DOCTYPE html>
2+
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
3+
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
4+
<head>
5+
<meta charset="utf-8">
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
8+
9+
10+
<link rel="shortcut icon" href="/img/favicon.ico">
11+
<title>python-batch-runner Documentation</title>
12+
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
13+
14+
<link rel="stylesheet" href="/css/theme.css" type="text/css" />
15+
<link rel="stylesheet" href="/css/theme_extra.css" type="text/css" />
16+
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
17+
<link href="/css/overrides.css" rel="stylesheet">
18+
19+
<script src="/js/jquery-2.1.1.min.js" defer></script>
20+
<script src="/js/modernizr-2.8.3.min.js" defer></script>
21+
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
22+
<script>hljs.initHighlightingOnLoad();</script>
23+
24+
</head>
25+
26+
<body class="wy-body-for-nav" role="document">
27+
28+
<div class="wy-grid-for-nav">
29+
30+
31+
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
32+
<div class="wy-side-nav-search">
33+
<a href="/." class="icon icon-home"> python-batch-runner Documentation</a>
34+
<div role="search">
35+
<form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
36+
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
37+
</form>
38+
</div>
39+
</div>
40+
41+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
42+
<ul class="current">
43+
44+
45+
<li class="toctree-l1">
46+
47+
<a class="" href="/.">Home</a>
48+
</li>
49+
50+
<li class="toctree-l1">
51+
52+
<a class="" href="/example/">Example</a>
53+
</li>
54+
55+
<li class="toctree-l1">
56+
57+
<span class="caption-text">User Guide</span>
58+
<ul class="subnav">
59+
<li class="">
60+
61+
<a class="" href="/user_guide/project_structure/">Basic Project Structure</a>
62+
</li>
63+
<li class="">
64+
65+
<a class="" href="/user_guide/app_profile/">Application Profile</a>
66+
</li>
67+
<li class="">
68+
69+
<a class="" href="/user_guide/lst_file/">Process List File</a>
70+
</li>
71+
<li class="">
72+
73+
<a class="" href="/user_guide/driverless/">Driverless Mode</a>
74+
</li>
75+
<li class="">
76+
77+
<a class="" href="/user_guide/driver/">Driver Mode</a>
78+
</li>
79+
<li class="">
80+
81+
<a class="" href="/user_guide/worker/">PyRunner Workers</a>
82+
</li>
83+
<li class="">
84+
85+
<a class="" href="/user_guide/restartability.md">Job Checkpointing & Restartability</a>
86+
</li>
87+
</ul>
88+
</li>
89+
90+
<li class="toctree-l1">
91+
92+
<span class="caption-text">Design</span>
93+
<ul class="subnav">
94+
<li class="">
95+
96+
<a class="" href="/design/">Overview</a>
97+
</li>
98+
<li class="">
99+
100+
<a class="" href="/design/config/">Config</a>
101+
</li>
102+
</ul>
103+
</li>
104+
105+
</ul>
106+
</div>
107+
&nbsp;
108+
</nav>
109+
110+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
111+
112+
113+
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
114+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
115+
<a href="/.">python-batch-runner Documentation</a>
116+
</nav>
117+
118+
119+
<div class="wy-nav-content">
120+
<div class="rst-content">
121+
<div role="navigation" aria-label="breadcrumbs navigation">
122+
<ul class="wy-breadcrumbs">
123+
<li><a href="/.">Docs</a> &raquo;</li>
124+
125+
126+
<li class="wy-breadcrumbs-aside">
127+
128+
</li>
129+
</ul>
130+
<hr/>
131+
</div>
132+
<div role="main">
133+
<div class="section">
134+
135+
136+
<h1 id="404-page-not-found">404</h1>
137+
138+
<p><strong>Page not found</strong></p>
139+
140+
141+
</div>
142+
</div>
143+
<footer>
144+
145+
146+
<hr/>
147+
148+
<div role="contentinfo">
149+
<!-- Copyright etc -->
150+
151+
</div>
152+
153+
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
154+
</footer>
155+
156+
</div>
157+
</div>
158+
159+
</section>
160+
161+
</div>
162+
163+
<div class="rst-versions" role="note" style="cursor: pointer">
164+
<span class="rst-current-version" data-toggle="rst-current-version">
165+
166+
167+
168+
</span>
169+
</div>
170+
<script>var base_url = '/';</script>
171+
<script src="/js/theme.js" defer></script>
172+
<script src="/search/main.js" defer></script>
173+
174+
</body>
175+
</html>

‎docs/css/overrides.css‎

Whitespace-only changes.

‎docs/css/theme.css‎

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/css/theme_extra.css‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
/*
2+
* Sphinx doesn't have support for section dividers like we do in
3+
* MkDocs, this styles the section titles in the nav
4+
*
5+
* https://github.com/mkdocs/mkdocs/issues/175
6+
*/
7+
.wy-menu-vertical span {
8+
line-height: 18px;
9+
padding: 0.4045em 1.618em;
10+
display: block;
11+
position: relative;
12+
font-size: 90%;
13+
color: #838383;
14+
}
15+
16+
.wy-menu-vertical .subnav a {
17+
padding: 0.4045em 2.427em;
18+
}
19+
20+
/*
21+
* Long navigations run off the bottom of the screen as the nav
22+
* area doesn't scroll.
23+
*
24+
* https://github.com/mkdocs/mkdocs/pull/202
25+
*
26+
* Builds upon pull 202 https://github.com/mkdocs/mkdocs/pull/202
27+
* to make toc scrollbar end before navigations buttons to not be overlapping.
28+
*/
29+
.wy-nav-side {
30+
height: calc(100% - 45px);
31+
overflow-y: auto;
32+
min-height: 0;
33+
}
34+
35+
.rst-versions{
36+
border-top: 0;
37+
height: 45px;
38+
}
39+
40+
@media screen and (max-width: 768px) {
41+
.wy-nav-side {
42+
height: 100%;
43+
}
44+
}
45+
46+
/*
47+
* readthedocs theme hides nav items when the window height is
48+
* too small to contain them.
49+
*
50+
* https://github.com/mkdocs/mkdocs/issues/#348
51+
*/
52+
.wy-menu-vertical ul {
53+
margin-bottom: 2em;
54+
}
55+
56+
/*
57+
* Wrap inline code samples otherwise they shoot of the side and
58+
* can't be read at all.
59+
*
60+
* https://github.com/mkdocs/mkdocs/issues/313
61+
* https://github.com/mkdocs/mkdocs/issues/233
62+
* https://github.com/mkdocs/mkdocs/issues/834
63+
*/
64+
code {
65+
white-space: pre-wrap;
66+
word-wrap: break-word;
67+
padding: 2px 5px;
68+
}
69+
70+
/**
71+
* Make code blocks display as blocks and give them the appropriate
72+
* font size and padding.
73+
*
74+
* https://github.com/mkdocs/mkdocs/issues/855
75+
* https://github.com/mkdocs/mkdocs/issues/834
76+
* https://github.com/mkdocs/mkdocs/issues/233
77+
*/
78+
pre code {
79+
white-space: pre;
80+
word-wrap: normal;
81+
display: block;
82+
padding: 12px;
83+
font-size: 12px;
84+
}
85+
86+
/*
87+
* Fix link colors when the link text is inline code.
88+
*
89+
* https://github.com/mkdocs/mkdocs/issues/718
90+
*/
91+
a code {
92+
color: #2980B9;
93+
}
94+
a:hover code {
95+
color: #3091d1;
96+
}
97+
a:visited code {
98+
color: #9B59B6;
99+
}
100+
101+
/*
102+
* The CSS classes from highlight.js seem to clash with the
103+
* ReadTheDocs theme causing some code to be incorrectly made
104+
* bold and italic.
105+
*
106+
* https://github.com/mkdocs/mkdocs/issues/411
107+
*/
108+
pre .cs, pre .c {
109+
font-weight: inherit;
110+
font-style: inherit;
111+
}
112+
113+
/*
114+
* Fix some issues with the theme and non-highlighted code
115+
* samples. Without and highlighting styles attached the
116+
* formatting is broken.
117+
*
118+
* https://github.com/mkdocs/mkdocs/issues/319
119+
*/
120+
.no-highlight {
121+
display: block;
122+
padding: 0.5em;
123+
color: #333;
124+
}
125+
126+
127+
/*
128+
* Additions specific to the search functionality provided by MkDocs
129+
*/
130+
131+
.search-results {
132+
margin-top: 23px;
133+
}
134+
135+
.search-results article {
136+
border-top: 1px solid #E1E4E5;
137+
padding-top: 24px;
138+
}
139+
140+
.search-results article:first-child {
141+
border-top: none;
142+
}
143+
144+
form .search-query {
145+
width: 100%;
146+
border-radius: 50px;
147+
padding: 6px 12px; /* csslint allow: box-model */
148+
border-color: #D1D4D5;
149+
}
150+
151+
.wy-menu-vertical li ul {
152+
display: inherit;
153+
}
154+
155+
.wy-menu-vertical li ul.subnav ul.subnav{
156+
padding-left: 1em;
157+
}
158+
159+
.wy-menu-vertical .subnav li.current > a {
160+
padding-left: 2.42em;
161+
}
162+
.wy-menu-vertical .subnav li.current > ul li a {
163+
padding-left: 3.23em;
164+
}
165+
166+
/*
167+
* Improve inline code blocks within admonitions.
168+
*
169+
* https://github.com/mkdocs/mkdocs/issues/656
170+
*/
171+
.admonition code {
172+
color: #404040;
173+
border: 1px solid #c7c9cb;
174+
border: 1px solid rgba(0, 0, 0, 0.2);
175+
background: #f8fbfd;
176+
background: rgba(255, 255, 255, 0.7);
177+
}
178+
179+
/*
180+
* Account for wide tables which go off the side.
181+
* Override borders to avoid wierdness on narrow tables.
182+
*
183+
* https://github.com/mkdocs/mkdocs/issues/834
184+
* https://github.com/mkdocs/mkdocs/pull/1034
185+
*/
186+
.rst-content .section .docutils {
187+
width: 100%;
188+
overflow: auto;
189+
display: block;
190+
border: none;
191+
}
192+
193+
td, th {
194+
border: 1px solid #e1e4e5 !important; /* csslint allow: important */
195+
border-collapse: collapse;
196+
}
197+

0 commit comments

Comments
 (0)