From 546015e6e147130c4f21c87ec9e1537d9f71c3fb Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Sat, 9 Nov 2013 19:42:01 -0500 Subject: - add a new sphinx extension "viewsource". takes advantage of part of the viewcode extension to allow ad-hoc display of the source of any file, as well as a "directory listing" structure. - reorganize examples/ to take advantage of new extension. in particular, keep moving all the descriptive text for files etc. into module docstrings, taking more advantage of self-documentation. --- examples/elementtree/adjacency_list.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'examples/elementtree/adjacency_list.py') diff --git a/examples/elementtree/adjacency_list.py b/examples/elementtree/adjacency_list.py index a3ad42778..5e27ba9ca 100644 --- a/examples/elementtree/adjacency_list.py +++ b/examples/elementtree/adjacency_list.py @@ -1,9 +1,17 @@ -"""illustrates an explicit way to persist an XML document expressed using ElementTree. +"""Illustrates an explicit way to persist an XML document expressed using ElementTree. + +Each DOM node is stored in an individual +table row, with attributes represented in a separate table. The +nodes are associated in a hierarchy using an adjacency list +structure. A query function is introduced which can search for nodes +along any path with a given structure of attributes, basically a +(very narrow) subset of xpath. This example explicitly marshals/unmarshals the ElementTree document into mapped entities which have their own tables. Compare to pickle.py which uses pickle to accomplish the same task. Note that the usage of both styles of persistence are identical, as is the structure of the main Document class. + """ ################################# PART I - Imports/Coniguration #################################### -- cgit v1.2.1