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/__init__.py | 23 +++-------------------- 1 file changed, 3 insertions(+), 20 deletions(-) (limited to 'examples/elementtree/__init__.py') diff --git a/examples/elementtree/__init__.py b/examples/elementtree/__init__.py index 6462dd562..66e9cfbbe 100644 --- a/examples/elementtree/__init__.py +++ b/examples/elementtree/__init__.py @@ -7,26 +7,6 @@ native cElementTree as well as lxml, and can be adapted to suit any kind of DOM representation system. Querying along xpath-like strings is illustrated as well. -In order of complexity: - -* ``pickle.py`` - Quick and dirty, serialize the whole DOM into a BLOB - column. While the example is very brief, it has very limited - functionality. - -* ``adjacency_list.py`` - 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. - -* ``optimized_al.py`` - Uses the same strategy as - ``adjacency_list.py``, but associates each DOM row with its owning - document row, so that a full document of DOM nodes can be loaded - using O(1) queries - the construction of the "hierarchy" is performed - after the load in a non-recursive fashion and is much more - efficient. - E.g.:: # parse an XML file and persist in the database @@ -39,4 +19,7 @@ E.g.:: # dump the XML print document +.. autosource:: + :files: pickle.py, adjacency_list.py, optimized_al.py + """ \ No newline at end of file -- cgit v1.2.1