docutils.utils.math.math2html.NumberGenerator

class documentation

class NumberGenerator(object): (source)

Known subclasses: docutils.utils.math.math2html.ChapteredGenerator

View In Hierarchy

A number generator for unique sequences and hierarchical structures. Used in:

Method create Create a counter for the given type.
Method createdependent Create a dependent counter given the master.
Method deasterisk Remove the possible asterisk in a layout type.
Method generate Generate a number for a layout type.
Method getcounter Get the counter for the given type.
Method getdependentcounter Get (or create) a counter of the given type that depends on another.
Method getlevel Get the level that corresponds to a layout type.
Method getparttype Obtain the type for the part: without the asterisk,
Method isinordered Find out if the layout type corresponds to an (un)ordered part.
Method isnumbered Find out if the type for a layout corresponds to a numbered layout.
Method isroman Find out if the layout type should have roman numeration.
Method isunique Find out if the layout type corresponds to a unique part.
Method isunordered Find out if the type contains an asterisk, basically.
Method startappendix Start appendices here.
Class Variable appendix Undocumented
Class Variable chaptered Undocumented
Class Variable counters Undocumented
Class Variable generator Undocumented
Class Variable orderedlayouts Undocumented
Class Variable romanlayouts Undocumented
def create(self, type): (source)

Create a counter for the given type.

def createdependent(self, type, master): (source)

Create a dependent counter given the master.

def deasterisk(self, type): (source)

Remove the possible asterisk in a layout type.

def generate(self, type): (source)
overridden in docutils.utils.math.math2html.ChapteredGenerator

Generate a number for a layout type.

def getcounter(self, type): (source)

Get the counter for the given type.

def getdependentcounter(self, type, master): (source)

Get (or create) a counter of the given type that depends on another.

def getlevel(self, type): (source)

Get the level that corresponds to a layout type.

def getparttype(self, type): (source)

Obtain the type for the part: without the asterisk,

def isinordered(self, type): (source)

Find out if the layout type corresponds to an (un)ordered part.

def isnumbered(self, type): (source)

Find out if the type for a layout corresponds to a numbered layout.

def isroman(self, type): (source)

Find out if the layout type should have roman numeration.

def isunique(self, type): (source)

Find out if the layout type corresponds to a unique part.

def isunordered(self, type): (source)

Find out if the type contains an asterisk, basically.

def startappendix(self): (source)

Start appendices here.

appendix = (source)

Undocumented

chaptered = (source)

Undocumented

counters = (source)

Undocumented

generator = (source)

Undocumented

orderedlayouts = (source)

Undocumented

romanlayouts = (source)

Undocumented