docstring

diff --git a/doc/build/read_markdown.py b/doc/build/read_markdown.py
index 0d5ae8be996e71348fd8bfe85517ca0b2cefc335..eee09ef3ef2b2e047ff0718d44ba328f0f62a96e 100644 (file)
--- 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