From 7aa1c3461f7b06b9d13917ae8f2f66de0a8d0eef Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Sun, 22 Oct 2006 03:07:01 +0000 Subject: [PATCH] docstring --- doc/build/read_markdown.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/build/read_markdown.py b/doc/build/read_markdown.py index 0d5ae8be99..eee09ef3ef 100644 --- a/doc/build/read_markdown.py +++ b/doc/build/read_markdown.py @@ -1,3 +1,10 @@ +"""loads Markdown files, converts each one to HTML and parses the HTML into an ElementTree structure. +The collection of ElementTrees are further parsed to generate a table of contents structure, and are + manipulated to replace various markdown-generated HTML with specific Myghty tags before being written + to Myghty templates, which then re-access the table of contents structure at runtime. + +Much thanks to Alexey Shamrin, who came up with the original idea and did all the heavy Markdown/Elementtree +lifting for this module.""" import sys, re, os from toc import TOCElement -- 2.47.2