Skip to content

Commit 685f502

Browse files
committed
[documentation] Update sphinx rst files
1 parent ad1629e commit 685f502

File tree

3 files changed

+32
-19
lines changed

3 files changed

+32
-19
lines changed

doc/base-classes.rst

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,13 @@ Again each Property can have multiple Values.
1010

1111
The odml Module contains wrappers, that are shortcuts for creating the main objects::
1212

13-
>>> from odml import Document, Section, Property, Value
13+
>>> from odml import Document, Section, Property
1414
>>> Document(version=0.9, author="Kermit")
1515
<Doc 0.9 by Kermit (0 sections)>
1616

1717
Several modules exist to extend the implementation.
1818
The ones included in the library are those:
1919

20-
* :py:mod:`odml.tools.event` provides event capabilities, allowing to add change-listeners to objects
21-
* :py:mod:`odml.tools.nodes` provides a tree-interface used by the gui with functions like next() and position()
22-
2320
Document
2421
--------
2522
.. autoclass:: odml.doc.BaseDocument
@@ -40,11 +37,3 @@ Property
4037
:members:
4138
:inherited-members:
4239
:undoc-members:
43-
44-
Value
45-
-----
46-
.. autoclass:: odml.value.BaseValue
47-
:members:
48-
:inherited-members:
49-
:undoc-members:
50-

doc/reference.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,4 @@ Class-Reference
66
:maxdepth: 2
77

88
base-classes
9-
mappings
109
tools
11-

doc/tools.rst

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Data Types
44
==========
55

6-
.. automodule:: odml.types
6+
.. automodule:: odml.dtypes
77
:members:
88
:inherited-members:
99
:undoc-members:
@@ -14,18 +14,44 @@ Tools
1414
=====
1515
Several tools are provided with the :py:mod:`odml.tools` package.
1616

17+
ODMLParser
18+
----------
19+
.. automodule:: odml.tools.odmlparser
20+
:members:
21+
:inherited-members:
22+
:undoc-members:
23+
1724
XMLParser
1825
---------
1926
.. automodule:: odml.tools.xmlparser
2027
:members:
2128
:inherited-members:
2229
:undoc-members:
2330

24-
Events
25-
------
26-
Events provide the possibility to place hooks on model-changes.
31+
DictParser
32+
----------
33+
.. automodule:: odml.tools.dict_parser
34+
:members:
35+
:inherited-members:
36+
:undoc-members:
2737

28-
.. automodule:: odml.tools.event
38+
FormatConverter
39+
----------------
40+
.. automodule:: odml.tools.format_converter
2941
:members:
42+
:inherited-members:
3043
:undoc-members:
3144

45+
VersionConverter
46+
----------------
47+
.. automodule:: odml.tools.version_converter
48+
:members:
49+
:inherited-members:
50+
:undoc-members:
51+
52+
RDFConverter
53+
----------------
54+
.. automodule:: odml.tools.rdf_converter
55+
:members:
56+
:inherited-members:
57+
:undoc-members:

0 commit comments

Comments
 (0)