Skip to content

Commit c4c9bfc

Browse files
martin-neotechmartin-neotech
authored
updated API docs to draft state (#398)
* updated API docs to draft state * fixed warnings on build * removed comment * changed the warning text that it is a draft * updates to API docs and pydoc * updates for api docs and pydoc * updates for api docs about session configuration * updates to api docs * updates for api docs * split into sections * added neo4j.exceptions
1 parent 3432e01 commit c4c9bfc

File tree

15 files changed

+1748
-237
lines changed

15 files changed

+1748
-237
lines changed

‎docs/source/_static/anchor_new_target.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!-- Adds target=_blank to external links -->
2+
$(document).ready(function () {
3+
$('a[href^="http://"], a[href^="https://"]').not('a[class*=internal]').attr('target', '_blank');
4+
});

‎docs/source/_static/nature_custom.css_t

Lines changed: 303 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,303 @@
1+
/*
2+
* nature_custom.css_t
3+
* ~~~~~~~~~~~~
4+
*
5+
* This stylesheet have been customized.
6+
* The original Sphinx stylesheet is -- nature theme.
7+
*
8+
* Copyright (c) 2007-2020 by the Sphinx team.
9+
* Copyright (c) 2020-2020 Neo4j
10+
* All rights reserved.
11+
*
12+
* Redistribution and use in source and binary forms, with or without
13+
* modification, are permitted provided that the following conditions are
14+
* met:
15+
*
16+
* * Redistributions of source code must retain the above copyright
17+
* notice, this list of conditions and the following disclaimer.
18+
*
19+
* * Redistributions in binary form must reproduce the above copyright
20+
* notice, this list of conditions and the following disclaimer in the
21+
* documentation and/or other materials provided with the distribution.
22+
*
23+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24+
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25+
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26+
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27+
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28+
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29+
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30+
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31+
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32+
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33+
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34+
*
35+
*/
36+
37+
@import url("basic.css");
38+
39+
/* -- page layout ----------------------------------------------------------- */
40+
41+
body {
42+
font-family: Arial, sans-serif;
43+
font-size: 100%;
44+
background-color: #fff;
45+
color: #555;
46+
margin: 0;
47+
padding: 0;
48+
}
49+
50+
div.documentwrapper {
51+
float: left;
52+
width: 100%;
53+
}
54+
55+
div.bodywrapper {
56+
margin: 0 0 0 400px !important;
57+
/*margin: 0 0 0 {{ theme_sidebarwidth|todim }};*/
58+
}
59+
60+
hr {
61+
border: 1px solid #B1B4B6;
62+
}
63+
64+
div.document {
65+
background-color: #eee;
66+
}
67+
68+
div.body {
69+
background-color: #ffffff;
70+
color: #3E4349;
71+
padding: 0 30px 30px 30px;
72+
font-size: 0.9em;
73+
}
74+
75+
div.footer {
76+
color: #555;
77+
width: 100%;
78+
padding: 13px 0;
79+
text-align: center;
80+
font-size: 75%;
81+
}
82+
83+
div.footer a {
84+
color: #444;
85+
text-decoration: underline;
86+
}
87+
88+
div.related {
89+
background-color: #000000;
90+
/*background-color: #6BA81E;*/
91+
line-height: 32px;
92+
color: #fff;
93+
text-shadow: none;
94+
/*text-shadow: 0px 1px 0 #444;*/
95+
font-size: 0.9em;
96+
}
97+
98+
div.related a {
99+
color: #ffffff;
100+
/*color: #E2F3CC;*/
101+
}
102+
103+
div.sphinxsidebar {
104+
width: 400px !important; /* new */
105+
font-size: 0.75em;
106+
line-height: 1.5em;
107+
}
108+
109+
div.sphinxsidebarwrapper{
110+
padding: 20px 0;
111+
}
112+
113+
div.sphinxsidebar h3,
114+
div.sphinxsidebar h4 {
115+
font-family: Arial, sans-serif;
116+
color: #000000;
117+
/*color: #222;*/
118+
font-size: 1.2em;
119+
font-weight: normal;
120+
margin: 0;
121+
padding: 5px 10px;
122+
background-color: #ffffff;
123+
/*background-color: #ddd;*/
124+
text-shadow: none;
125+
/*text-shadow: 1px 1px 0 white;*/
126+
}
127+
128+
div.sphinxsidebar h4{
129+
font-size: 1.1em;
130+
}
131+
132+
div.sphinxsidebar h3 a {
133+
color: #444;
134+
}
135+
136+
137+
div.sphinxsidebar p {
138+
color: #888;
139+
padding: 5px 20px;
140+
}
141+
142+
div.sphinxsidebar p.topless {
143+
}
144+
145+
div.sphinxsidebar ul {
146+
margin: 10px 20px;
147+
padding: 0;
148+
color: #000;
149+
}
150+
151+
div.sphinxsidebar a {
152+
color: #444;
153+
}
154+
155+
div.sphinxsidebar input {
156+
border: 1px solid #ccc;
157+
font-family: sans-serif;
158+
font-size: 1em;
159+
}
160+
161+
div.sphinxsidebar .searchformwrapper {
162+
margin-left: 20px;
163+
margin-right: 20px;
164+
}
165+
166+
/* -- body styles ----------------------------------------------------------- */
167+
168+
a {
169+
color: #005B81;
170+
text-decoration: none;
171+
}
172+
173+
a:hover {
174+
color: #E32E00;
175+
text-decoration: underline;
176+
}
177+
178+
div.body h1,
179+
div.body h2,
180+
div.body h3,
181+
div.body h4,
182+
div.body h5,
183+
div.body h6 {
184+
font-family: Arial, sans-serif;
185+
background-color: #a9d3ff;
186+
/*background-color: #BED4EB;*/
187+
font-weight: normal;
188+
color: #212224;
189+
margin: 30px 0px 10px 0px;
190+
padding: 5px 0 5px 10px;
191+
text-shadow: none;
192+
/*text-shadow: 0px 1px 0 white;*/
193+
}
194+
195+
div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; }
196+
div.body h2 { font-size: 150%; background-color: #a9d3ff; }
197+
div.body h3 { font-size: 120%; background-color: #a9d3ff; }
198+
div.body h4 { font-size: 110%; background-color: #a9d3ff; }
199+
div.body h5 { font-size: 100%; background-color: #a9d3ff; }
200+
div.body h6 { font-size: 100%; background-color: #a9d3ff; }
201+
202+
a.headerlink {
203+
color: #c60f0f;
204+
font-size: 0.8em;
205+
padding: 0 4px 0 4px;
206+
text-decoration: none;
207+
}
208+
209+
a.headerlink:hover {
210+
background-color: #c60f0f;
211+
color: white;
212+
}
213+
214+
div.body p, div.body dd, div.body li {
215+
line-height: 1.5em;
216+
}
217+
218+
div.admonition p.admonition-title + p {
219+
display: inline;
220+
}
221+
222+
div.highlight{
223+
background-color: white;
224+
}
225+
226+
div.note {
227+
background-color: #eee;
228+
border: 1px solid #ccc;
229+
}
230+
231+
div.seealso {
232+
background-color: #ffc;
233+
border: 1px solid #ff6;
234+
}
235+
236+
div.topic {
237+
background-color: #eee;
238+
}
239+
240+
div.warning {
241+
background-color: #ffe4e4;
242+
border: 1px solid #f66;
243+
}
244+
245+
div.note {
246+
background-color: #20ff0050;
247+
border: 1px solid #000000;
248+
}
249+
250+
p.admonition-title {
251+
display: inline;
252+
}
253+
254+
p.admonition-title:after {
255+
content: ":";
256+
}
257+
258+
pre {
259+
padding: 10px;
260+
background-color: #f0f0f0;
261+
/*background-color: white;*/
262+
color: #222;
263+
line-height: 1.2em;
264+
border: 1px solid #000000;
265+
/*border: 1px solid #C6C9CB;*/
266+
font-size: 1.1em;
267+
margin: 1.5em 0 1.5em 0;
268+
/*-webkit-box-shadow: 1px 1px 1px #d8d8d8;*/
269+
/*-moz-box-shadow: 1px 1px 1px #d8d8d8;*/
270+
}
271+
272+
code {
273+
background-color: #ecf0f3;
274+
color: #222;
275+
/* padding: 1px 2px; */
276+
font-size: 1.1em;
277+
font-family: monospace;
278+
}
279+
280+
.viewcode-back {
281+
font-family: Arial, sans-serif;
282+
}
283+
284+
div.viewcode-block:target {
285+
background-color: #f4debf;
286+
border-top: 1px solid #ac9;
287+
border-bottom: 1px solid #ac9;
288+
}
289+
290+
div.code-block-caption {
291+
background-color: #ddd;
292+
color: #222;
293+
border: 1px solid #C6C9CB;
294+
}
295+
296+
297+
li > p:first-child {
298+
margin-top: 10px;
299+
}
300+
301+
li > p:last-child {
302+
margin-top: 10px;
303+
}

0 commit comments

Comments
 (0)