Skip to content

Commit 1eda0ef

Browse files
generated files
1 parent 242e700 commit 1eda0ef

14 files changed

+320
-58
lines changed

document.bson

222 Bytes
Binary file not shown.

document.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"MyBook": {
3+
"title": "My life in Python",
4+
"sections": {
5+
"Abstract": {
6+
"paragraphs": [
7+
{
8+
"contents": "Blah blah blah"
9+
},
10+
{
11+
"contents": "Blah2"
12+
}
13+
]
14+
},
15+
"Chapter 1": {
16+
"paragraphs": [
17+
{
18+
"contents": "More..."
19+
}
20+
]
21+
}
22+
}
23+
}
24+
}

document.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
## Document
2+
A model for documents.
3+
4+
### Allowed parameters
5+
<table>
6+
<tr>
7+
<td><b>id</b></td>
8+
<td>str</td>
9+
<td><i>The unique id of the document</i></td>
10+
</tr>
11+
12+
13+
<tr>
14+
<td><b>title</b></td>
15+
<td>str</td>
16+
<td><i>The document title</i></td>
17+
</tr>
18+
19+
20+
<tr>
21+
<td><b>ISBN</b></td>
22+
<td>int</td>
23+
<td><i>International Standard Book Number</i></td>
24+
</tr>
25+
26+
27+
</table>
28+
29+
### Allowed children
30+
<table>
31+
<tr>
32+
<td><b>sections</b></td>
33+
<td><a href="#section">Section</a></td>
34+
<td><i>The sections of the document</i></td>
35+
</tr>
36+
37+
38+
</table>
39+
40+
## Section
41+
A model of a section of the <a href="#document">Document</a>. Will contain one <a href="#paragraph">Paragraph</a> or more, i.e the <a href="#paragraph">Paragraph</a>(s) in the section, probably related to the <b>title</b> of the `Document <#document>`_.
42+
43+
### Allowed parameters
44+
<table>
45+
<tr>
46+
<td><b>id</b></td>
47+
<td>str</td>
48+
<td><i>The id of the section</i></td>
49+
</tr>
50+
51+
52+
</table>
53+
54+
### Allowed children
55+
<table>
56+
<tr>
57+
<td><b>paragraphs</b></td>
58+
<td><a href="#paragraph">Paragraph</a></td>
59+
<td><i>The paragraphs</i></td>
60+
</tr>
61+
62+
63+
</table>
64+
65+
## Paragraph
66+
A model of a paragraph.
67+
68+
### Allowed parameters
69+
<table>
70+
<tr>
71+
<td><b>contents</b></td>
72+
<td>str</td>
73+
<td><i>Paragraph contents, which make up the <a href="#section">Section</a>s.</i></td>
74+
</tr>
75+
76+
77+
</table>
78+

document.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
========
2+
Document
3+
========
4+
A model for documents.
5+
6+
**Allowed parameters**
7+
8+
=============== =========== ==================================
9+
Allowed field Data Type Description
10+
=============== =========== ==================================
11+
**id** str The unique id of the document
12+
**title** str The document title
13+
**ISBN** int International Standard Book Number
14+
=============== =========== ==================================
15+
16+
**Allowed children**
17+
18+
=============== ====================== ============================
19+
Allowed child Data Type Description
20+
=============== ====================== ============================
21+
**sections** `Section <#section>`__ The sections of the document
22+
=============== ====================== ============================
23+
24+
=======
25+
Section
26+
=======
27+
A model of a section of the `Document <#document>`__. Will contain one `Paragraph <#paragraph>`__ or more, i.e the `Paragraph(s) <#paragraph>`__ in the section, probably related to the **title** of the `Document <#document>`_.
28+
29+
**Allowed parameters**
30+
31+
=============== =========== =====================
32+
Allowed field Data Type Description
33+
=============== =========== =====================
34+
**id** str The id of the section
35+
=============== =========== =====================
36+
37+
**Allowed children**
38+
39+
=============== ========================== ==============
40+
Allowed child Data Type Description
41+
=============== ========================== ==============
42+
**paragraphs** `Paragraph <#paragraph>`__ The paragraphs
43+
=============== ========================== ==============
44+
45+
=========
46+
Paragraph
47+
=========
48+
A model of a paragraph.
49+
50+
**Allowed parameters**
51+
52+
=============== =========== ==============================================================
53+
Allowed field Data Type Description
54+
=============== =========== ==============================================================
55+
**contents** str Paragraph contents, which make up the `Sections <#section>`__.
56+
=============== =========== ==============================================================
57+

document.specification.bson

996 Bytes
Binary file not shown.

document.specification.json

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"Document": {
3+
"definition": "A model for documents.",
4+
"allowed_parameters": {
5+
"id": {
6+
"type": "str",
7+
"description": "The unique id of the document"
8+
},
9+
"title": {
10+
"type": "str",
11+
"description": "The document title"
12+
},
13+
"ISBN": {
14+
"type": "int",
15+
"description": "International Standard Book Number"
16+
}
17+
},
18+
"allowed_children": {
19+
"sections": {
20+
"type": "Section",
21+
"description": "The sections of the document"
22+
}
23+
}
24+
},
25+
"Section": {
26+
"definition": "A model of a section of the :class:`Document`. Will contain one :class:`Paragraph` or more, i.e the :class:`Paragraph`(s) in the section, probably related to the :code:`title` of the `Document <#document>`_.",
27+
"allowed_parameters": {
28+
"id": {
29+
"type": "str",
30+
"description": "The id of the section"
31+
}
32+
},
33+
"allowed_children": {
34+
"paragraphs": {
35+
"type": "Paragraph",
36+
"description": "The paragraphs"
37+
}
38+
}
39+
},
40+
"Paragraph": {
41+
"definition": "A model of a paragraph.",
42+
"allowed_parameters": {
43+
"contents": {
44+
"type": "str",
45+
"description": "Paragraph contents, which make up the :class:`Section`s."
46+
}
47+
}
48+
}
49+
}

document.specification.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Document:
2+
definition: A model for documents.
3+
allowed_parameters:
4+
id:
5+
type: str
6+
description: The unique id of the document
7+
title:
8+
type: str
9+
description: The document title
10+
ISBN:
11+
type: int
12+
description: International Standard Book Number
13+
allowed_children:
14+
sections:
15+
type: Section
16+
description: The sections of the document
17+
Section:
18+
definition: A model of a section of the :class:`Document`. Will contain one :class:`Paragraph`
19+
or more, i.e the :class:`Paragraph`(s) in the section, probably related to
20+
the :code:`title` of the `Document <#document>`_.
21+
allowed_parameters:
22+
id:
23+
type: str
24+
description: The id of the section
25+
allowed_children:
26+
paragraphs:
27+
type: Paragraph
28+
description: The paragraphs
29+
Paragraph:
30+
definition: A model of a paragraph.
31+
allowed_parameters:
32+
contents:
33+
type: str
34+
description: Paragraph contents, which make up the :class:`Section`s.

document.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0" ?>
2+
<Document id="MyBook" title="My life in Python" ISBN="None">
3+
<Section id="Abstract">
4+
<Paragraph contents="Blah blah blah"/>
5+
<Paragraph contents="Blah2"/>
6+
</Section>
7+
<Section id="Chapter 1">
8+
<Paragraph contents="More..."/>
9+
</Section>
10+
</Document>

document.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
MyBook:
2+
title: My life in Python
3+
sections:
4+
Abstract:
5+
paragraphs:
6+
- contents: Blah blah blah
7+
- contents: Blah2
8+
Chapter 1:
9+
paragraphs:
10+
- contents: More...

examples/neuroml2/NeuroML2.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
## NeuroML
1+
## neuroML
22
Some description...
33

44
### Allowed parameters
55
<table>
66
<tr>
77
<td><b>id</b></td>
88
<td>str</td>
9-
<td><i>The id of the NeuroML 2 document</i></td>
9+
<td><i>The id of the neuroML 2 document</i></td>
1010
</tr>
1111

1212

1313
<tr>
1414
<td><b>version</b></td>
1515
<td>str</td>
16-
<td><i>NeuroML version used</i></td>
16+
<td><i>neuroML version used</i></td>
1717
</tr>
1818

1919

@@ -23,28 +23,28 @@ Some description...
2323
<table>
2424
<tr>
2525
<td><b>izhikevich2007Cells</b></td>
26-
<td><a href="#izhikevich2007cell">Izhikevich2007Cell</a></td>
26+
<td><a href="#izhikevich2007cell">izhikevich2007Cell</a></td>
2727
<td><i></i></td>
2828
</tr>
2929

3030

3131
<tr>
3232
<td><b>pulseGenerators</b></td>
33-
<td><a href="#pulsegenerator">PulseGenerator</a></td>
33+
<td><a href="#pulsegenerator">pulseGenerator</a></td>
3434
<td><i></i></td>
3535
</tr>
3636

3737

3838
<tr>
3939
<td><b>networks</b></td>
40-
<td><a href="#network">Network</a></td>
40+
<td><a href="#network">network</a></td>
4141
<td><i>The networks present</i></td>
4242
</tr>
4343

4444

4545
</table>
4646

47-
## Izhikevich2007Cell
47+
## izhikevich2007Cell
4848
Some description...
4949

5050
### Allowed parameters
@@ -128,7 +128,7 @@ Some description...
128128

129129
</table>
130130

131-
## PulseGenerator
131+
## pulseGenerator
132132
Some description...
133133

134134
### Allowed parameters
@@ -163,7 +163,7 @@ Some description...
163163

164164
</table>
165165

166-
## Network
166+
## network
167167
Some description...
168168

169169
### Allowed parameters
@@ -181,21 +181,21 @@ Some description...
181181
<table>
182182
<tr>
183183
<td><b>populations</b></td>
184-
<td><a href="#population">Population</a></td>
184+
<td><a href="#population">population</a></td>
185185
<td><i>the pops in the net</i></td>
186186
</tr>
187187

188188

189189
<tr>
190190
<td><b>explicitInputs</b></td>
191-
<td><a href="#explicitinput">ExplicitInput</a></td>
191+
<td><a href="#explicitinput">explicitInput</a></td>
192192
<td><i></i></td>
193193
</tr>
194194

195195

196196
</table>
197197

198-
## Population
198+
## population
199199
Some description...
200200

201201
### Allowed parameters
@@ -223,7 +223,7 @@ Some description...
223223

224224
</table>
225225

226-
## ExplicitInput
226+
## explicitInput
227227
Some description...
228228

229229
### Allowed parameters

0 commit comments

Comments
 (0)