stove/tiramisu
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add epydoc api documentation

Browse source
This commit is contained in:
gwen 2012-05-22 09:25:39 +02:00
parent e1a9b10d5a
commit 19db2feb35
10 changed files with 343 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README
View file

@ -11,7 +11,8 @@ See gpl-3.0.txt for more informations.
Contributors:
Gwenaël Rémond <gremond@cadoles.com> lead developer
Emmanuel Garette <egarette@cadoles.com>
Emmanuel Garette <egarette@cadoles.com> contributor

7
doc/Makefile
View file

@ -5,7 +5,7 @@ HTMLFRAGMENT=$(addsuffix .html, $(basename $(SRC)))
.PHONY: all clean
all: html code
all: html code epydoc
# make -C ./build/code all
# make -C ./build/test all
# make -C ./build all
@ -18,8 +18,9 @@ html: $(HTMLFRAGMENT)
code:
./code2html
epydoc:
./epydoc.sh
clean:
make -C ./build clean
make -C ./pydoc/ clean
# make -C ./build/test clean

1
doc/build/Makefile vendored
View file

@ -4,3 +4,4 @@
clean:
rm -f *.html
rm -f api/*.html
make -C ./pydoc/ clean

0
doc/pydoc/Makefile → doc/build/pydoc/Makefile vendored
View file

332
doc/build/pydoc/api-objects.txt vendored Normal file
View file

@ -0,0 +1,332 @@
tiramisu.config tiramisu.config-module.html
tiramisu.config.__package__ tiramisu.config-module.html#__package__
tiramisu.config.auto_factory tiramisu.config-module.html#auto_factory
tiramisu.config.special_owner_factory tiramisu.config-module.html#special_owner_factory
tiramisu.config.make_dict tiramisu.config-module.html#make_dict
tiramisu.config.special_owners tiramisu.config-module.html#special_owners
tiramisu.config.apply_requires tiramisu.option-module.html#apply_requires
tiramisu.option tiramisu.option-module.html
tiramisu.option.__package__ tiramisu.option-module.html#__package__
tiramisu.option.reverse_actions tiramisu.option-module.html#reverse_actions
tiramisu.option.group_types tiramisu.option-module.html#group_types
tiramisu.option.modes tiramisu.option-module.html#modes
tiramisu.option.apply_requires tiramisu.option-module.html#apply_requires
tiramisu.option.available_actions tiramisu.option-module.html#available_actions
tiramisu.config.Config tiramisu.config.Config-class.html
tiramisu.config.Config.set tiramisu.config.Config-class.html#set
tiramisu.config.Config.unwrap_from_name tiramisu.config.Config-class.html#unwrap_from_name
tiramisu.config.Config.cfgimpl_unfreeze tiramisu.config.Config-class.html#cfgimpl_unfreeze
tiramisu.config.Config._validate tiramisu.config.Config-class.html#_validate
tiramisu.config.Config.__str__ tiramisu.config.Config-class.html#__str__
tiramisu.config.Config.cfgimpl_set_owner tiramisu.config.Config-class.html#cfgimpl_set_owner
tiramisu.config.Config.getkey tiramisu.config.Config-class.html#getkey
tiramisu.config.Config._cfgimpl_mandatory tiramisu.config.Config-class.html#_cfgimpl_mandatory
tiramisu.config.Config.unwrap_from_path tiramisu.config.Config-class.html#unwrap_from_path
tiramisu.config.Config.__init__ tiramisu.config.Config-class.html#__init__
tiramisu.config.Config._validate_duplicates tiramisu.config.Config-class.html#_validate_duplicates
tiramisu.config.Config._cfgimpl_owner tiramisu.config.Config-class.html#_cfgimpl_owner
tiramisu.config.Config.__getattr__ tiramisu.config.Config-class.html#__getattr__
tiramisu.config.Config._cfgimpl_hidden tiramisu.config.Config-class.html#_cfgimpl_hidden
tiramisu.config.Config.iter_groups tiramisu.config.Config-class.html#iter_groups
tiramisu.config.Config.get_warnings tiramisu.config.Config-class.html#get_warnings
tiramisu.config.Config.cfgimpl_update tiramisu.config.Config-class.html#cfgimpl_update
tiramisu.config.Config.override tiramisu.config.Config-class.html#override
tiramisu.config.Config.setoption tiramisu.config.Config-class.html#setoption
tiramisu.config.Config.__ne__ tiramisu.config.Config-class.html#__ne__
tiramisu.config.Config.cfgimpl_disable tiramisu.config.Config-class.html#cfgimpl_disable
tiramisu.config.Config.__hash__ tiramisu.config.Config-class.html#__hash__
tiramisu.config.Config.get tiramisu.config.Config-class.html#get
tiramisu.config.Config._cfgimpl_get_toplevel tiramisu.config.Config-class.html#_cfgimpl_get_toplevel
tiramisu.config.Config._cfgimpl_build tiramisu.config.Config-class.html#_cfgimpl_build
tiramisu.config.Config.__setattr__ tiramisu.config.Config-class.html#__setattr__
tiramisu.config.Config.is_frozen tiramisu.config.Config-class.html#is_frozen
tiramisu.config.Config.__iter__ tiramisu.config.Config-class.html#__iter__
tiramisu.config.Config._cfgimpl_toplevel tiramisu.config.Config-class.html#_cfgimpl_toplevel
tiramisu.config.Config._cfgimpl_get_home_by_path tiramisu.config.Config-class.html#_cfgimpl_get_home_by_path
tiramisu.config.Config._cfgimpl_mode tiramisu.config.Config-class.html#_cfgimpl_mode
tiramisu.config.Config.cfgimpl_read_write tiramisu.config.Config-class.html#cfgimpl_read_write
tiramisu.config.Config.__eq__ tiramisu.config.Config-class.html#__eq__
tiramisu.config.Config.__dir__ tiramisu.config.Config-class.html#__dir__
tiramisu.config.Config.getpaths tiramisu.config.Config-class.html#getpaths
tiramisu.config.Config.cfgimpl_set_mode tiramisu.config.Config-class.html#cfgimpl_set_mode
tiramisu.config.Config.cfgimpl_hide tiramisu.config.Config-class.html#cfgimpl_hide
tiramisu.config.Config.cfgimpl_show tiramisu.config.Config-class.html#cfgimpl_show
tiramisu.config.Config._cfgimpl_frozen tiramisu.config.Config-class.html#_cfgimpl_frozen
tiramisu.config.Config._cfgimpl_disabled tiramisu.config.Config-class.html#_cfgimpl_disabled
tiramisu.config.Config.__delattr__ tiramisu.config.Config-class.html#__delattr__
tiramisu.config.Config.add_warning tiramisu.config.Config-class.html#add_warning
tiramisu.config.Config.cfgimpl_enable tiramisu.config.Config-class.html#cfgimpl_enable
tiramisu.config.Config.cfgimpl_freeze tiramisu.config.Config-class.html#cfgimpl_freeze
tiramisu.config.Config.cfgimpl_read_only tiramisu.config.Config-class.html#cfgimpl_read_only
tiramisu.option.ArbitraryOption tiramisu.option.ArbitraryOption-class.html
tiramisu.option.HiddenBaseType.show tiramisu.option.HiddenBaseType-class.html#show
tiramisu.option.Option.getkey tiramisu.option.Option-class.html#getkey
tiramisu.option.DisabledBaseType.disabled tiramisu.option.DisabledBaseType-class.html#disabled
tiramisu.option.Option.setowner tiramisu.option.Option-class.html#setowner
tiramisu.option.DisabledBaseType._is_disabled tiramisu.option.DisabledBaseType-class.html#_is_disabled
tiramisu.option.ArbitraryOption.__init__ tiramisu.option.ArbitraryOption-class.html#__init__
tiramisu.option.Option.is_mandatory tiramisu.option.Option-class.html#is_mandatory
tiramisu.option.ModeBaseType.set_mode tiramisu.option.ModeBaseType-class.html#set_mode
tiramisu.option.HiddenBaseType._is_hidden tiramisu.option.HiddenBaseType-class.html#_is_hidden
tiramisu.option.ModeBaseType.get_mode tiramisu.option.ModeBaseType-class.html#get_mode
tiramisu.option.DisabledBaseType.enable tiramisu.option.DisabledBaseType-class.html#enable
tiramisu.option.Option.setoption tiramisu.option.Option-class.html#setoption
tiramisu.option.DisabledBaseType.disable tiramisu.option.DisabledBaseType-class.html#disable
tiramisu.option.Option.getcallback tiramisu.option.Option-class.html#getcallback
tiramisu.option.HiddenBaseType.hide tiramisu.option.HiddenBaseType-class.html#hide
tiramisu.option.ArbitraryOption.validate tiramisu.option.ArbitraryOption-class.html#validate
tiramisu.option.Option.freeze tiramisu.option.Option-class.html#freeze
tiramisu.option.HiddenBaseType.hidden tiramisu.option.HiddenBaseType-class.html#hidden
tiramisu.option.Option._frozen tiramisu.option.Option-class.html#_frozen
tiramisu.option.Option.getdoc tiramisu.option.Option-class.html#getdoc
tiramisu.option.Option.is_multi tiramisu.option.Option-class.html#is_multi
tiramisu.option.ArbitraryOption.getdefault tiramisu.option.ArbitraryOption-class.html#getdefault
tiramisu.option.Option.unfreeze tiramisu.option.Option-class.html#unfreeze
tiramisu.option.ModeBaseType.mode tiramisu.option.ModeBaseType-class.html#mode
tiramisu.option.BoolOption tiramisu.option.BoolOption-class.html
tiramisu.option.HiddenBaseType.show tiramisu.option.HiddenBaseType-class.html#show
tiramisu.option.BoolOption.opt_type tiramisu.option.BoolOption-class.html#opt_type
tiramisu.option.Option.getkey tiramisu.option.Option-class.html#getkey
tiramisu.option.DisabledBaseType.disabled tiramisu.option.DisabledBaseType-class.html#disabled
tiramisu.option.Option.setowner tiramisu.option.Option-class.html#setowner
tiramisu.option.DisabledBaseType._is_disabled tiramisu.option.DisabledBaseType-class.html#_is_disabled
tiramisu.option.BoolOption.__init__ tiramisu.option.BoolOption-class.html#__init__
tiramisu.option.Option.is_mandatory tiramisu.option.Option-class.html#is_mandatory
tiramisu.option.ModeBaseType.set_mode tiramisu.option.ModeBaseType-class.html#set_mode
tiramisu.option.HiddenBaseType._is_hidden tiramisu.option.HiddenBaseType-class.html#_is_hidden
tiramisu.option.HiddenBaseType.hidden tiramisu.option.HiddenBaseType-class.html#hidden
tiramisu.option.DisabledBaseType.enable tiramisu.option.DisabledBaseType-class.html#enable
tiramisu.option.Option.setoption tiramisu.option.Option-class.html#setoption
tiramisu.option.DisabledBaseType.disable tiramisu.option.DisabledBaseType-class.html#disable
tiramisu.option.Option.getcallback tiramisu.option.Option-class.html#getcallback
tiramisu.option.HiddenBaseType.hide tiramisu.option.HiddenBaseType-class.html#hide
tiramisu.option.BoolOption.validate tiramisu.option.BoolOption-class.html#validate
tiramisu.option.Option.freeze tiramisu.option.Option-class.html#freeze
tiramisu.option.ModeBaseType.get_mode tiramisu.option.ModeBaseType-class.html#get_mode
tiramisu.option.Option._frozen tiramisu.option.Option-class.html#_frozen
tiramisu.option.Option.getdoc tiramisu.option.Option-class.html#getdoc
tiramisu.option.Option.is_multi tiramisu.option.Option-class.html#is_multi
tiramisu.option.Option.getdefault tiramisu.option.Option-class.html#getdefault
tiramisu.option.Option.unfreeze tiramisu.option.Option-class.html#unfreeze
tiramisu.option.ModeBaseType.mode tiramisu.option.ModeBaseType-class.html#mode
tiramisu.option.ChoiceOption tiramisu.option.ChoiceOption-class.html
tiramisu.option.HiddenBaseType.show tiramisu.option.HiddenBaseType-class.html#show
tiramisu.option.ChoiceOption.opt_type tiramisu.option.ChoiceOption-class.html#opt_type
tiramisu.option.Option.getkey tiramisu.option.Option-class.html#getkey
tiramisu.option.DisabledBaseType.disabled tiramisu.option.DisabledBaseType-class.html#disabled
tiramisu.option.Option.setowner tiramisu.option.Option-class.html#setowner
tiramisu.option.DisabledBaseType._is_disabled tiramisu.option.DisabledBaseType-class.html#_is_disabled
tiramisu.option.ChoiceOption.__init__ tiramisu.option.ChoiceOption-class.html#__init__
tiramisu.option.Option.is_mandatory tiramisu.option.Option-class.html#is_mandatory
tiramisu.option.ModeBaseType.set_mode tiramisu.option.ModeBaseType-class.html#set_mode
tiramisu.option.HiddenBaseType._is_hidden tiramisu.option.HiddenBaseType-class.html#_is_hidden
tiramisu.option.HiddenBaseType.hidden tiramisu.option.HiddenBaseType-class.html#hidden
tiramisu.option.DisabledBaseType.enable tiramisu.option.DisabledBaseType-class.html#enable
tiramisu.option.ChoiceOption.setoption tiramisu.option.ChoiceOption-class.html#setoption
tiramisu.option.DisabledBaseType.disable tiramisu.option.DisabledBaseType-class.html#disable
tiramisu.option.Option.getcallback tiramisu.option.Option-class.html#getcallback
tiramisu.option.HiddenBaseType.hide tiramisu.option.HiddenBaseType-class.html#hide
tiramisu.option.ChoiceOption.validate tiramisu.option.ChoiceOption-class.html#validate
tiramisu.option.Option.freeze tiramisu.option.Option-class.html#freeze
tiramisu.option.ModeBaseType.get_mode tiramisu.option.ModeBaseType-class.html#get_mode
tiramisu.option.Option._frozen tiramisu.option.Option-class.html#_frozen
tiramisu.option.Option.getdoc tiramisu.option.Option-class.html#getdoc
tiramisu.option.Option.is_multi tiramisu.option.Option-class.html#is_multi
tiramisu.option.Option.getdefault tiramisu.option.Option-class.html#getdefault
tiramisu.option.Option.unfreeze tiramisu.option.Option-class.html#unfreeze
tiramisu.option.ModeBaseType.mode tiramisu.option.ModeBaseType-class.html#mode
tiramisu.option.DisabledBaseType tiramisu.option.DisabledBaseType-class.html
tiramisu.option.DisabledBaseType.enable tiramisu.option.DisabledBaseType-class.html#enable
tiramisu.option.DisabledBaseType.disable tiramisu.option.DisabledBaseType-class.html#disable
tiramisu.option.DisabledBaseType.disabled tiramisu.option.DisabledBaseType-class.html#disabled
tiramisu.option.DisabledBaseType._is_disabled tiramisu.option.DisabledBaseType-class.html#_is_disabled
tiramisu.option.FloatOption tiramisu.option.FloatOption-class.html
tiramisu.option.HiddenBaseType.show tiramisu.option.HiddenBaseType-class.html#show
tiramisu.option.FloatOption.opt_type tiramisu.option.FloatOption-class.html#opt_type
tiramisu.option.Option.getkey tiramisu.option.Option-class.html#getkey
tiramisu.option.DisabledBaseType.disabled tiramisu.option.DisabledBaseType-class.html#disabled
tiramisu.option.Option.setowner tiramisu.option.Option-class.html#setowner
tiramisu.option.DisabledBaseType._is_disabled tiramisu.option.DisabledBaseType-class.html#_is_disabled
tiramisu.option.FloatOption.__init__ tiramisu.option.FloatOption-class.html#__init__
tiramisu.option.Option.is_mandatory tiramisu.option.Option-class.html#is_mandatory
tiramisu.option.ModeBaseType.set_mode tiramisu.option.ModeBaseType-class.html#set_mode
tiramisu.option.HiddenBaseType._is_hidden tiramisu.option.HiddenBaseType-class.html#_is_hidden
tiramisu.option.HiddenBaseType.hidden tiramisu.option.HiddenBaseType-class.html#hidden
tiramisu.option.DisabledBaseType.enable tiramisu.option.DisabledBaseType-class.html#enable
tiramisu.option.FloatOption.setoption tiramisu.option.FloatOption-class.html#setoption
tiramisu.option.DisabledBaseType.disable tiramisu.option.DisabledBaseType-class.html#disable
tiramisu.option.Option.getcallback tiramisu.option.Option-class.html#getcallback
tiramisu.option.HiddenBaseType.hide tiramisu.option.HiddenBaseType-class.html#hide
tiramisu.option.FloatOption.validate tiramisu.option.FloatOption-class.html#validate
tiramisu.option.Option.freeze tiramisu.option.Option-class.html#freeze
tiramisu.option.ModeBaseType.get_mode tiramisu.option.ModeBaseType-class.html#get_mode
tiramisu.option.Option._frozen tiramisu.option.Option-class.html#_frozen
tiramisu.option.Option.getdoc tiramisu.option.Option-class.html#getdoc
tiramisu.option.Option.is_multi tiramisu.option.Option-class.html#is_multi
tiramisu.option.Option.getdefault tiramisu.option.Option-class.html#getdefault
tiramisu.option.Option.unfreeze tiramisu.option.Option-class.html#unfreeze
tiramisu.option.ModeBaseType.mode tiramisu.option.ModeBaseType-class.html#mode
tiramisu.option.HiddenBaseType tiramisu.option.HiddenBaseType-class.html
tiramisu.option.HiddenBaseType.hide tiramisu.option.HiddenBaseType-class.html#hide
tiramisu.option.HiddenBaseType.show tiramisu.option.HiddenBaseType-class.html#show
tiramisu.option.HiddenBaseType._is_hidden tiramisu.option.HiddenBaseType-class.html#_is_hidden
tiramisu.option.HiddenBaseType.hidden tiramisu.option.HiddenBaseType-class.html#hidden
tiramisu.option.IPOption tiramisu.option.IPOption-class.html
tiramisu.option.HiddenBaseType.show tiramisu.option.HiddenBaseType-class.html#show
tiramisu.option.IPOption.opt_type tiramisu.option.IPOption-class.html#opt_type
tiramisu.option.Option.getkey tiramisu.option.Option-class.html#getkey
tiramisu.option.DisabledBaseType.disabled tiramisu.option.DisabledBaseType-class.html#disabled
tiramisu.option.Option.setowner tiramisu.option.Option-class.html#setowner
tiramisu.option.DisabledBaseType._is_disabled tiramisu.option.DisabledBaseType-class.html#_is_disabled
tiramisu.option.IPOption.__init__ tiramisu.option.IPOption-class.html#__init__
tiramisu.option.Option.is_mandatory tiramisu.option.Option-class.html#is_mandatory
tiramisu.option.ModeBaseType.set_mode tiramisu.option.ModeBaseType-class.html#set_mode
tiramisu.option.HiddenBaseType._is_hidden tiramisu.option.HiddenBaseType-class.html#_is_hidden
tiramisu.option.HiddenBaseType.hidden tiramisu.option.HiddenBaseType-class.html#hidden
tiramisu.option.DisabledBaseType.enable tiramisu.option.DisabledBaseType-class.html#enable
tiramisu.option.IPOption.setoption tiramisu.option.IPOption-class.html#setoption
tiramisu.option.DisabledBaseType.disable tiramisu.option.DisabledBaseType-class.html#disable
tiramisu.option.Option.getcallback tiramisu.option.Option-class.html#getcallback
tiramisu.option.HiddenBaseType.hide tiramisu.option.HiddenBaseType-class.html#hide
tiramisu.option.IPOption.validate tiramisu.option.IPOption-class.html#validate
tiramisu.option.Option.freeze tiramisu.option.Option-class.html#freeze
tiramisu.option.ModeBaseType.get_mode tiramisu.option.ModeBaseType-class.html#get_mode
tiramisu.option.Option._frozen tiramisu.option.Option-class.html#_frozen
tiramisu.option.Option.getdoc tiramisu.option.Option-class.html#getdoc
tiramisu.option.Option.is_multi tiramisu.option.Option-class.html#is_multi
tiramisu.option.Option.getdefault tiramisu.option.Option-class.html#getdefault
tiramisu.option.Option.unfreeze tiramisu.option.Option-class.html#unfreeze
tiramisu.option.ModeBaseType.mode tiramisu.option.ModeBaseType-class.html#mode
tiramisu.option.IntOption tiramisu.option.IntOption-class.html
tiramisu.option.HiddenBaseType.show tiramisu.option.HiddenBaseType-class.html#show
tiramisu.option.IntOption.opt_type tiramisu.option.IntOption-class.html#opt_type
tiramisu.option.Option.getkey tiramisu.option.Option-class.html#getkey
tiramisu.option.DisabledBaseType.disabled tiramisu.option.DisabledBaseType-class.html#disabled
tiramisu.option.Option.setowner tiramisu.option.Option-class.html#setowner
tiramisu.option.DisabledBaseType._is_disabled tiramisu.option.DisabledBaseType-class.html#_is_disabled
tiramisu.option.IntOption.__init__ tiramisu.option.IntOption-class.html#__init__
tiramisu.option.Option.is_mandatory tiramisu.option.Option-class.html#is_mandatory
tiramisu.option.ModeBaseType.set_mode tiramisu.option.ModeBaseType-class.html#set_mode
tiramisu.option.HiddenBaseType._is_hidden tiramisu.option.HiddenBaseType-class.html#_is_hidden
tiramisu.option.HiddenBaseType.hidden tiramisu.option.HiddenBaseType-class.html#hidden
tiramisu.option.DisabledBaseType.enable tiramisu.option.DisabledBaseType-class.html#enable
tiramisu.option.IntOption.setoption tiramisu.option.IntOption-class.html#setoption
tiramisu.option.DisabledBaseType.disable tiramisu.option.DisabledBaseType-class.html#disable
tiramisu.option.Option.getcallback tiramisu.option.Option-class.html#getcallback
tiramisu.option.HiddenBaseType.hide tiramisu.option.HiddenBaseType-class.html#hide
tiramisu.option.IntOption.validate tiramisu.option.IntOption-class.html#validate
tiramisu.option.Option.freeze tiramisu.option.Option-class.html#freeze
tiramisu.option.ModeBaseType.get_mode tiramisu.option.ModeBaseType-class.html#get_mode
tiramisu.option.Option._frozen tiramisu.option.Option-class.html#_frozen
tiramisu.option.Option.getdoc tiramisu.option.Option-class.html#getdoc
tiramisu.option.Option.is_multi tiramisu.option.Option-class.html#is_multi
tiramisu.option.Option.getdefault tiramisu.option.Option-class.html#getdefault
tiramisu.option.Option.unfreeze tiramisu.option.Option-class.html#unfreeze
tiramisu.option.ModeBaseType.mode tiramisu.option.ModeBaseType-class.html#mode
tiramisu.option.ModeBaseType tiramisu.option.ModeBaseType-class.html
tiramisu.option.ModeBaseType.set_mode tiramisu.option.ModeBaseType-class.html#set_mode
tiramisu.option.ModeBaseType.mode tiramisu.option.ModeBaseType-class.html#mode
tiramisu.option.ModeBaseType.get_mode tiramisu.option.ModeBaseType-class.html#get_mode
tiramisu.option.NetmaskOption tiramisu.option.NetmaskOption-class.html
tiramisu.option.HiddenBaseType.show tiramisu.option.HiddenBaseType-class.html#show
tiramisu.option.NetmaskOption.opt_type tiramisu.option.NetmaskOption-class.html#opt_type
tiramisu.option.Option.getkey tiramisu.option.Option-class.html#getkey
tiramisu.option.DisabledBaseType.disabled tiramisu.option.DisabledBaseType-class.html#disabled
tiramisu.option.Option.setowner tiramisu.option.Option-class.html#setowner
tiramisu.option.DisabledBaseType._is_disabled tiramisu.option.DisabledBaseType-class.html#_is_disabled
tiramisu.option.NetmaskOption.__init__ tiramisu.option.NetmaskOption-class.html#__init__
tiramisu.option.Option.is_mandatory tiramisu.option.Option-class.html#is_mandatory
tiramisu.option.ModeBaseType.set_mode tiramisu.option.ModeBaseType-class.html#set_mode
tiramisu.option.HiddenBaseType._is_hidden tiramisu.option.HiddenBaseType-class.html#_is_hidden
tiramisu.option.HiddenBaseType.hidden tiramisu.option.HiddenBaseType-class.html#hidden
tiramisu.option.DisabledBaseType.enable tiramisu.option.DisabledBaseType-class.html#enable
tiramisu.option.NetmaskOption.setoption tiramisu.option.NetmaskOption-class.html#setoption
tiramisu.option.DisabledBaseType.disable tiramisu.option.DisabledBaseType-class.html#disable
tiramisu.option.Option.getcallback tiramisu.option.Option-class.html#getcallback
tiramisu.option.HiddenBaseType.hide tiramisu.option.HiddenBaseType-class.html#hide
tiramisu.option.NetmaskOption.validate tiramisu.option.NetmaskOption-class.html#validate
tiramisu.option.Option.freeze tiramisu.option.Option-class.html#freeze
tiramisu.option.ModeBaseType.get_mode tiramisu.option.ModeBaseType-class.html#get_mode
tiramisu.option.Option._frozen tiramisu.option.Option-class.html#_frozen
tiramisu.option.Option.getdoc tiramisu.option.Option-class.html#getdoc
tiramisu.option.Option.is_multi tiramisu.option.Option-class.html#is_multi
tiramisu.option.Option.getdefault tiramisu.option.Option-class.html#getdefault
tiramisu.option.Option.unfreeze tiramisu.option.Option-class.html#unfreeze
tiramisu.option.ModeBaseType.mode tiramisu.option.ModeBaseType-class.html#mode
tiramisu.option.Option tiramisu.option.Option-class.html
tiramisu.option.HiddenBaseType.show tiramisu.option.HiddenBaseType-class.html#show
tiramisu.option.Option.getkey tiramisu.option.Option-class.html#getkey
tiramisu.option.DisabledBaseType.disabled tiramisu.option.DisabledBaseType-class.html#disabled
tiramisu.option.Option.setowner tiramisu.option.Option-class.html#setowner
tiramisu.option.DisabledBaseType._is_disabled tiramisu.option.DisabledBaseType-class.html#_is_disabled
tiramisu.option.Option.__init__ tiramisu.option.Option-class.html#__init__
tiramisu.option.Option.is_mandatory tiramisu.option.Option-class.html#is_mandatory
tiramisu.option.ModeBaseType.set_mode tiramisu.option.ModeBaseType-class.html#set_mode
tiramisu.option.HiddenBaseType._is_hidden tiramisu.option.HiddenBaseType-class.html#_is_hidden
tiramisu.option.HiddenBaseType.hidden tiramisu.option.HiddenBaseType-class.html#hidden
tiramisu.option.DisabledBaseType.enable tiramisu.option.DisabledBaseType-class.html#enable
tiramisu.option.Option.setoption tiramisu.option.Option-class.html#setoption
tiramisu.option.DisabledBaseType.disable tiramisu.option.DisabledBaseType-class.html#disable
tiramisu.option.Option.getcallback tiramisu.option.Option-class.html#getcallback
tiramisu.option.HiddenBaseType.hide tiramisu.option.HiddenBaseType-class.html#hide
tiramisu.option.Option.validate tiramisu.option.Option-class.html#validate
tiramisu.option.Option.freeze tiramisu.option.Option-class.html#freeze
tiramisu.option.ModeBaseType.get_mode tiramisu.option.ModeBaseType-class.html#get_mode
tiramisu.option.Option._frozen tiramisu.option.Option-class.html#_frozen
tiramisu.option.Option.getdoc tiramisu.option.Option-class.html#getdoc
tiramisu.option.Option.is_multi tiramisu.option.Option-class.html#is_multi
tiramisu.option.Option.getdefault tiramisu.option.Option-class.html#getdefault
tiramisu.option.Option.unfreeze tiramisu.option.Option-class.html#unfreeze
tiramisu.option.ModeBaseType.mode tiramisu.option.ModeBaseType-class.html#mode
tiramisu.option.OptionDescription tiramisu.option.OptionDescription-class.html
tiramisu.option.OptionDescription.show tiramisu.option.OptionDescription-class.html#show
tiramisu.option.OptionDescription.add_child tiramisu.option.OptionDescription-class.html#add_child
tiramisu.option.DisabledBaseType.disabled tiramisu.option.DisabledBaseType-class.html#disabled
tiramisu.option.DisabledBaseType._is_disabled tiramisu.option.DisabledBaseType-class.html#_is_disabled
tiramisu.option.OptionDescription.__init__ tiramisu.option.OptionDescription-class.html#__init__
tiramisu.option.OptionDescription.hide tiramisu.option.OptionDescription-class.html#hide
tiramisu.option.ModeBaseType.set_mode tiramisu.option.ModeBaseType-class.html#set_mode
tiramisu.option.OptionDescription.get_group_type tiramisu.option.OptionDescription-class.html#get_group_type
tiramisu.option.OptionDescription.update_child tiramisu.option.OptionDescription-class.html#update_child
tiramisu.option.OptionDescription.set_group_type tiramisu.option.OptionDescription-class.html#set_group_type
tiramisu.option.HiddenBaseType._is_hidden tiramisu.option.HiddenBaseType-class.html#_is_hidden
tiramisu.option.HiddenBaseType.hidden tiramisu.option.HiddenBaseType-class.html#hidden
tiramisu.option.OptionDescription.group_type tiramisu.option.OptionDescription-class.html#group_type
tiramisu.option.OptionDescription.getpaths tiramisu.option.OptionDescription-class.html#getpaths
tiramisu.option.OptionDescription.enable tiramisu.option.OptionDescription-class.html#enable
tiramisu.option.OptionDescription.disable tiramisu.option.OptionDescription-class.html#disable
tiramisu.option.OptionDescription.getkey tiramisu.option.OptionDescription-class.html#getkey
tiramisu.option.ModeBaseType.get_mode tiramisu.option.ModeBaseType-class.html#get_mode
tiramisu.option.OptionDescription._build tiramisu.option.OptionDescription-class.html#_build
tiramisu.option.OptionDescription.getdoc tiramisu.option.OptionDescription-class.html#getdoc
tiramisu.option.ModeBaseType.mode tiramisu.option.ModeBaseType-class.html#mode
tiramisu.option.StrOption tiramisu.option.StrOption-class.html
tiramisu.option.HiddenBaseType.show tiramisu.option.HiddenBaseType-class.html#show
tiramisu.option.StrOption.opt_type tiramisu.option.StrOption-class.html#opt_type
tiramisu.option.Option.getkey tiramisu.option.Option-class.html#getkey
tiramisu.option.DisabledBaseType.disabled tiramisu.option.DisabledBaseType-class.html#disabled
tiramisu.option.Option.setowner tiramisu.option.Option-class.html#setowner
tiramisu.option.DisabledBaseType._is_disabled tiramisu.option.DisabledBaseType-class.html#_is_disabled
tiramisu.option.StrOption.__init__ tiramisu.option.StrOption-class.html#__init__
tiramisu.option.Option.is_mandatory tiramisu.option.Option-class.html#is_mandatory
tiramisu.option.ModeBaseType.set_mode tiramisu.option.ModeBaseType-class.html#set_mode
tiramisu.option.HiddenBaseType._is_hidden tiramisu.option.HiddenBaseType-class.html#_is_hidden
tiramisu.option.HiddenBaseType.hidden tiramisu.option.HiddenBaseType-class.html#hidden
tiramisu.option.DisabledBaseType.enable tiramisu.option.DisabledBaseType-class.html#enable
tiramisu.option.StrOption.setoption tiramisu.option.StrOption-class.html#setoption
tiramisu.option.DisabledBaseType.disable tiramisu.option.DisabledBaseType-class.html#disable
tiramisu.option.Option.getcallback tiramisu.option.Option-class.html#getcallback
tiramisu.option.HiddenBaseType.hide tiramisu.option.HiddenBaseType-class.html#hide
tiramisu.option.StrOption.validate tiramisu.option.StrOption-class.html#validate
tiramisu.option.Option.freeze tiramisu.option.Option-class.html#freeze
tiramisu.option.ModeBaseType.get_mode tiramisu.option.ModeBaseType-class.html#get_mode
tiramisu.option.Option._frozen tiramisu.option.Option-class.html#_frozen
tiramisu.option.Option.getdoc tiramisu.option.Option-class.html#getdoc
tiramisu.option.Option.is_multi tiramisu.option.Option-class.html#is_multi
tiramisu.option.Option.getdefault tiramisu.option.Option-class.html#getdefault
tiramisu.option.Option.unfreeze tiramisu.option.Option-class.html#unfreeze
tiramisu.option.ModeBaseType.mode tiramisu.option.ModeBaseType-class.html#mode
tiramisu.option.SymLinkOption tiramisu.option.SymLinkOption-class.html
tiramisu.option.SymLinkOption.setoption tiramisu.option.SymLinkOption-class.html#setoption
tiramisu.option.SymLinkOption.opt_type tiramisu.option.SymLinkOption-class.html#opt_type
tiramisu.option.SymLinkOption.__init__ tiramisu.option.SymLinkOption-class.html#__init__

0
doc/pydoc/crarr.png → doc/build/pydoc/crarr.png vendored
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 340 B

After

Width:  |  Height:  |  Size: 340 B

0
doc/pydoc/epydoc.css → doc/build/pydoc/epydoc.css vendored
View file

0
doc/pydoc/epydoc.js → doc/build/pydoc/epydoc.js vendored
View file

2
doc/epydoc.sh
View file

@ -1,3 +1,3 @@
epydoc --css grayscale -o ./pydoc ../config.py ../option.py
epydoc --css grayscale -o ./build/pydoc ../config.py ../option.py
#apirst2html.py --stylesheet=docutils.css --external-api=epydoc --external-api-root=epydoc:./api/ --external-api-file=epydoc:./api/api-objects.txt doc.txt > doc.htm

3
doc/index.txt
View file

@ -30,7 +30,10 @@ configuration handler.
- :doc:`configapi` and :doc:`optionapi` describe the API's details,
- :doc:`status` for a summary of the `Option`'s and `Config`'s statuses,
- :doc:`consistency` for the local and global integrity constraints,
- :doc:`glossary` describes the specific terms used in Tiramisu.
- :doc:`pydoc/index` for the developer's API