Package SLIMdoc

Functions
def	myAction
def	makedef
def	maketut
def	how_to_gen
def	howto_emitter
def	term_builder
def	term_emitter
def	tutorial_index
def	index_emitter
def	index_emitter_demo
Variables
string	__copyright__
string	__license__
tuple	term_template = Template("""\\term{ ${term} }${abstract}\\textbf{Author:} ${author}\\citetitle[${link}]{${term}}""")
tuple	re_title = re.compile(r'\\title\{(.*?)\}')
tuple	re_author = re.compile(r'\\author\{(.*?)\}')
list	default_name = lambdaall,def_:allandall[0]
list	GLOBAL_TERMS_DEMOS = []
list	GLOBAL_TERMS_TUTOR = []
	add_to_demos = GLOBAL_TERMS_DEMOS.append
	add_to_tutorials = GLOBAL_TERMS_TUTOR.append

---

Function Documentation

def SLIMdoc.how_to_gen	(		source,
			target,
			env,
			for_signature
	)

Definition at line 91 of file SLIMdoc.py.

def SLIMdoc.howto_emitter	(		target,
			source,
			env
	)

Definition at line 118 of file SLIMdoc.py.

def SLIMdoc.index_emitter	(		target,
			source,
			env
	)

Definition at line 175 of file SLIMdoc.py.

def SLIMdoc.index_emitter_demo	(		target,
			source,
			env
	)

Definition at line 182 of file SLIMdoc.py.

def SLIMdoc.makedef	(		file_name,
			lines,
			link = None
	)

Definition at line 46 of file SLIMdoc.py.

def SLIMdoc.maketut

(

terms

)

Definition at line 79 of file SLIMdoc.py.

def SLIMdoc.myAction

(

cmd_str

)

Definition at line 28 of file SLIMdoc.py.

def SLIMdoc.term_builder	(		target,
			source,
			env
	)

Definition at line 152 of file SLIMdoc.py.

def SLIMdoc.term_emitter	(		target,
			source,
			env
	)

Definition at line 159 of file SLIMdoc.py.

def SLIMdoc.tutorial_index	(		target,
			source,
			env
	)

Definition at line 167 of file SLIMdoc.py.

---

Variable Documentation

string __copyright__

Initial value:

"""
Copyright 2008 Sean Ross-Ross
"""

Definition at line 1 of file SLIMdoc.py.

string __license__

Initial value:

"""
This file is part of SLIMpy .

SLIMpy is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

SLIMpy is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with SLIMpy . If not, see <http://www.gnu.org/licenses/>.
"""

Definition at line 4 of file SLIMdoc.py.

add_to_demos = GLOBAL_TERMS_DEMOS.append

Definition at line 148 of file SLIMdoc.py.

add_to_tutorials = GLOBAL_TERMS_TUTOR.append

Definition at line 149 of file SLIMdoc.py.

list default_name = lambdaall,def_:allandall[0]

Definition at line 45 of file SLIMdoc.py.

list GLOBAL_TERMS_DEMOS = []

Definition at line 145 of file SLIMdoc.py.

list GLOBAL_TERMS_TUTOR = []

Definition at line 146 of file SLIMdoc.py.

tuple re_author = re.compile(r'\\author\{(.*?)\}')

Definition at line 44 of file SLIMdoc.py.

tuple re_title = re.compile(r'\\title\{(.*?)\}')

Definition at line 43 of file SLIMdoc.py.

tuple term_template = Template("""\\term{ ${term} }${abstract}\\textbf{Author:} ${author}\\citetitle[${link}]{${term}}""")

Definition at line 33 of file SLIMdoc.py.