summaryrefslogtreecommitdiffstatshomepage
path: root/tools/gendoc.py
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2014-08-10 16:51:26 +0100
committerDamien George <damien.p.george@gmail.com>2014-08-10 16:51:26 +0100
commitc4ee39dd636e15bc9d8dd3adbdffe42971546220 (patch)
treefa7b99a0e2fed595d7def2cd5f2cd347308c0b55 /tools/gendoc.py
parent5f930337bc352641699390ac1bf37ba64cd486d8 (diff)
downloadmicropython-c4ee39dd636e15bc9d8dd3adbdffe42971546220.tar.gz
micropython-c4ee39dd636e15bc9d8dd3adbdffe42971546220.zip
tools, gendoc: Output small descr about module TOC.
Diffstat (limited to 'tools/gendoc.py')
-rw-r--r--tools/gendoc.py11
1 files changed, 6 insertions, 5 deletions
diff --git a/tools/gendoc.py b/tools/gendoc.py
index b277ea6561..26c3a18596 100644
--- a/tools/gendoc.py
+++ b/tools/gendoc.py
@@ -327,12 +327,13 @@ class Doc:
def dump(self):
s = []
- if self.modules:
+ s.append('# Modules')
+ s.append('')
+ s.append('These are the Python modules that are implemented.')
+ s.append('')
+ for m in sorted(self.modules.values(), key=lambda x:x.name):
s.append('')
- s.append('# Modules')
- for m in sorted(self.modules.values(), key=lambda x:x.name):
- s.append('')
- s.append('[`{}`]({}) - {}'.format(m.name, m.name, m.descr))
+ s.append('[`{}`]({}/) - {}'.format(m.name, m.name, m.descr))
return '\n'.join(s)
def write(self, dir):