diff options
| author | gjhiggins <devnull@localhost> | 2009-05-17 13:59:04 +0000 |
|---|---|---|
| committer | gjhiggins <devnull@localhost> | 2009-05-17 13:59:04 +0000 |
| commit | 657db7e2020368d54e160ccf1b96bf69d82f0561 (patch) | |
| tree | 3c407c0aecb36552e671279480e2f438797aab37 /docs/modules | |
| parent | e942e31d1b34aa4b24a784fa0ebeb313cab0fb97 (diff) | |
| download | rdflib-657db7e2020368d54e160ccf1b96bf69d82f0561.tar.gz | |
Added Sphinx-ified docs, also rendered to html for convenience.
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/graphs/conjunctive_graph.rst | 15 | ||||
| -rw-r--r-- | docs/modules/graphs/graph.rst | 12 | ||||
| -rw-r--r-- | docs/modules/graphs/index.rst | 22 | ||||
| -rw-r--r-- | docs/modules/index.rst | 15 | ||||
| -rw-r--r-- | docs/modules/nodes/bnode.rst | 10 | ||||
| -rw-r--r-- | docs/modules/nodes/identifier.rst | 10 | ||||
| -rw-r--r-- | docs/modules/nodes/index.rst | 22 | ||||
| -rw-r--r-- | docs/modules/nodes/literal.rst | 10 | ||||
| -rw-r--r-- | docs/modules/nodes/node.rst | 10 | ||||
| -rw-r--r-- | docs/modules/nodes/quoted_graph.rst | 13 | ||||
| -rw-r--r-- | docs/modules/nodes/uriref.rst | 12 | ||||
| -rw-r--r-- | docs/modules/nodes/variable.rst | 9 | ||||
| -rw-r--r-- | docs/modules/others.rst | 76 |
13 files changed, 236 insertions, 0 deletions
diff --git a/docs/modules/graphs/conjunctive_graph.rst b/docs/modules/graphs/conjunctive_graph.rst new file mode 100644 index 00000000..a0eefdb2 --- /dev/null +++ b/docs/modules/graphs/conjunctive_graph.rst @@ -0,0 +1,15 @@ +:mod:`rdflib.Graph.ConjunctiveGraph` -- ConjunctiveGraph class definition +========================================================================= + +================= +Conjunctive Graph +================= + +.. automodule:: rdflib.graph + + +Module Contents +--------------- + +.. autoclass:: rdflib.graph.ConjunctiveGraph + :members: diff --git a/docs/modules/graphs/graph.rst b/docs/modules/graphs/graph.rst new file mode 100644 index 00000000..962489bd --- /dev/null +++ b/docs/modules/graphs/graph.rst @@ -0,0 +1,12 @@ +:mod:`rdflib.Graph.Graph` -- Graph class definition +=================================================== + +===== +Graph +===== + +Module Contents +--------------- + +.. autoclass:: rdflib.graph.Graph + :members: diff --git a/docs/modules/graphs/index.rst b/docs/modules/graphs/index.rst new file mode 100644 index 00000000..b66a5a8e --- /dev/null +++ b/docs/modules/graphs/index.rst @@ -0,0 +1,22 @@ +.. _graphs: + +======= +Graphs +======= + +RDFLib defines the following kinds of Graphs: + +* 'Graph'(_''store''_,_''identifier''_) +* 'QuotedGraph'(_''store''_,_''identifier''_) +* 'ConjunctiveGraph'(_''store''_,_''default''_''identifier''_= ''None'') + +A Conjunctive Graph is the most relevant collection of graphs that are considered to be the boundary for closed world assumptions. This boundary is equivalent to that of the store instance (which is itself uniquely identified and distinct from other instances of :class:`Store` that signify other Conjunctive Graphs). It is equivalent to all the named graphs within it and associated with a ``_default_`` graph which is automatically assigned a :class:`BNode` for an identifier - if one isn't given. + +.. automodule:: rdflib.graph + +.. toctree:: + :maxdepth: 2 + + graph + conjunctive_graph + ../nodes/quoted_graph
\ No newline at end of file diff --git a/docs/modules/index.rst b/docs/modules/index.rst new file mode 100644 index 00000000..75eaec1c --- /dev/null +++ b/docs/modules/index.rst @@ -0,0 +1,15 @@ +.. _modules: + +======= +Modules +======= + +Contents: +========= + +.. toctree:: + :maxdepth: 3 + + nodes/index + graphs/index + others diff --git a/docs/modules/nodes/bnode.rst b/docs/modules/nodes/bnode.rst new file mode 100644 index 00000000..587f31a6 --- /dev/null +++ b/docs/modules/nodes/bnode.rst @@ -0,0 +1,10 @@ +:mod:`rdflib.term.BNode` -- RDF blank node functions +==================================================== + +.. automodule:: rdflib.term + +Module Contents +--------------- + +.. autoclass:: rdflib.term.BNode + :members: diff --git a/docs/modules/nodes/identifier.rst b/docs/modules/nodes/identifier.rst new file mode 100644 index 00000000..bbd0b108 --- /dev/null +++ b/docs/modules/nodes/identifier.rst @@ -0,0 +1,10 @@ +:mod:`rdflib.term.Identifier` -- Identifier class definition +============================================================ + +.. automodule:: rdflib.term + +Module Contents +--------------- + +.. autoclass:: rdflib.term.Identifier + :members: diff --git a/docs/modules/nodes/index.rst b/docs/modules/nodes/index.rst new file mode 100644 index 00000000..b9fa6a15 --- /dev/null +++ b/docs/modules/nodes/index.rst @@ -0,0 +1,22 @@ +.. _nodes: + +======= +Nodes +======= + +The RDFLib classes listed below model RDF `terms`__ in a graph and inherit from a common `Identifier`_ class, which extends Python unicode. Instances of these are nodes in an RDF graph. + +.. toctree:: + :maxdepth: 2 + + node + identifier + bnode + uriref + literal + variable + quoted_graph + + +.. __: univrdfstore.html#Terms +.. _Identifier: http://www.w3.org/2002/07/rdf-identifer-terminology/ diff --git a/docs/modules/nodes/literal.rst b/docs/modules/nodes/literal.rst new file mode 100644 index 00000000..ad408b9a --- /dev/null +++ b/docs/modules/nodes/literal.rst @@ -0,0 +1,10 @@ +:mod:`rdflib.term.Literal` -- Literal class definition +====================================================== + +.. automodule:: rdflib.term + +Module Contents +--------------- + +.. autoclass:: rdflib.term.Literal + :members: diff --git a/docs/modules/nodes/node.rst b/docs/modules/nodes/node.rst new file mode 100644 index 00000000..90fd2c5d --- /dev/null +++ b/docs/modules/nodes/node.rst @@ -0,0 +1,10 @@ +:mod:`rdflib.term.Node` -- Node class definition +================================================ + +.. automodule:: rdflib.term + +Module Contents +--------------- + +.. autoclass:: rdflib.term.Node + :members: diff --git a/docs/modules/nodes/quoted_graph.rst b/docs/modules/nodes/quoted_graph.rst new file mode 100644 index 00000000..0d202e23 --- /dev/null +++ b/docs/modules/nodes/quoted_graph.rst @@ -0,0 +1,13 @@ +:mod:`rdflib.graph.QuotedGraph` -- Quoted graphs +================================================ + +RDFLib graphs support an additional extension of RDF semantics for formulae. For the academically inclined, Graham Kyles `formal extension`__ is probably a good read. + +.. __: http://ninebynine.org/RDFNotes/UsingContextsWithRDF.html#xtocid-6303976 + +Formulae are represented formally by the :class:`rdflib.Graph.QuotedGraph` class and are disjoint from regular RDF graphs in that their statements are quoted. + +Module Contents +--------------- + +.. autoclass:: rdflib.graph.QuotedGraph diff --git a/docs/modules/nodes/uriref.rst b/docs/modules/nodes/uriref.rst new file mode 100644 index 00000000..672d2b54 --- /dev/null +++ b/docs/modules/nodes/uriref.rst @@ -0,0 +1,12 @@ +:mod:`rdflib.term.URIRef` -- URIRef class definition +==================================================== + +.. automodule:: rdflib.term + + + +Module Contents +--------------- + +.. autoclass:: rdflib.term.URIRef + :members: diff --git a/docs/modules/nodes/variable.rst b/docs/modules/nodes/variable.rst new file mode 100644 index 00000000..651c9a36 --- /dev/null +++ b/docs/modules/nodes/variable.rst @@ -0,0 +1,9 @@ +:mod:`rdflib.term.Variable` -- Variable class definition +======================================================== + +.. automodule:: rdflib.term + +Module Contents +--------------- + +.. autoclass:: rdflib.term.Variable diff --git a/docs/modules/others.rst b/docs/modules/others.rst new file mode 100644 index 00000000..2eb22584 --- /dev/null +++ b/docs/modules/others.rst @@ -0,0 +1,76 @@ +.. _others: Other modules + +============= +Other modules +============= + +Collection +---------- +.. automodule:: rdflib.collection + +.. autoclass:: rdflib.collection.Collection + :members: + +Journal +------- +.. automodule:: rdflib.journal + +.. autoclass:: rdflib.journal.JournalWriter + :members: + +.. autoclass:: rdflib.journal.JournalReader + :members: + +QueryResult +----------- +.. automodule:: rdflib.query.result +.. autoclass:: rdflib.query.result.QueryResult + :members: + +Statement +--------- +.. automodule:: rdflib.term +.. autoclass:: rdflib.term.Statement +.. automethod:: rdflib.term.Statement.__new__ +.. automethod:: rdflib.term.Statement.__reduce__ + +StringInputSource +----------------- +.. automodule:: rdflib.parser +.. autoclass:: rdflib.parser.StringInputSource + :members: + +TextIndex +--------- +.. automodule:: rdflib.textindex +.. autoclass:: rdflib.textindex.TextIndex + :members: + +TripleStore +----------- +.. automodule:: rdflib.TripleStore +.. autoclass:: rdflib.TripleStore.TripleStore + :members: + +URLInputSource +-------------- + +.. autoclass:: rdflib.parser.URLInputSource + :members: + +query +----- +.. automodule:: rdflib.query + +store +----- +.. automodule:: rdflib.store + +sparql +------ +.. automodule:: rdflib.sparql + +syntax +------ +.. automodule:: rdflib.syntax + |
