diff options
author | Cyrille Bagard <nocbos@gmail.com> | 2015-10-27 16:49:10 (GMT) |
---|---|---|
committer | Cyrille Bagard <nocbos@gmail.com> | 2015-10-27 16:49:10 (GMT) |
commit | 51e0be89c8f94ddc1bb023a4fb7ce4161e42df98 (patch) | |
tree | 810e9249d82d527b5da88d5de103b10930a9a985 /tools/gendocs/exporter.py | |
parent | 602ac694fc28885a496a7cf377a8cdd08221da4d (diff) |
Added a tool to update Python documentation online.
git-svn-id: svn://svn.gna.org/svn/chrysalide/trunk@601 abbe820e-26c8-41b2-8c08-b7b2b41f8b0a
Diffstat (limited to 'tools/gendocs/exporter.py')
-rw-r--r-- | tools/gendocs/exporter.py | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/tools/gendocs/exporter.py b/tools/gendocs/exporter.py new file mode 100644 index 0000000..c34c468 --- /dev/null +++ b/tools/gendocs/exporter.py @@ -0,0 +1,95 @@ +#!/usr/bin/python3 +# -*- coding: utf-8 -*- + + +class DocExporter: + """Exporte une documentation d'une façon donnée.""" + + + def open(self, name, fullname): + """Initialise les propriétés utiles.""" + + pass + + + def close(self): + """Termine l'édition de la documentation.""" + + pass + + + def show_list_sub_modules(self, gparent, parent, others, builder): + """Affiche des renvois vers les sous-parties présentes.""" + + pass + + + def show_list_sub_classes(self, parent, classes, builder): + """Affiche des renvois vers les sous-parties présentes.""" + + pass + + + def describe_module(self, desc): + """Affiche la description du module courant.""" + + pass + + + def start_main_section(self, title): + """Affiche un en-tête pour la zone des classes.""" + + pass + + + def show_class_info(self, name, desc): + """Affiche les informations générales d'une classe.""" + + pass + + + def show_info_section(self, title): + """Affiche une section d'informations particulières.""" + + pass + + + def begin_hierarchy_level(self): + """Démarre une arborescence hiérarchique.""" + + pass + + + def terminate_hierarchy_level(self): + """Arrête une arborescence hiérarchique.""" + + pass + + + def print_hierarchy_level(self, fullname, name, page, level): + """Affiche un élément hiérarchique.""" + + pass + + + def show_constant_info(self, name): + """Affiche un élément de type 'constant'.""" + + pass + + + def show_data_info(self, name, value): + """Affiche un élément de type 'donnée'.""" + + pass + + def show_attribute_info(self, name, desc): + """Affiche un élément de type 'attribut'.""" + + pass + + + def show_callable_info(self, ret, name, args, desc): + """Affiche un élément de type 'routine'.""" + + pass |