Builder Base Class (regolith.builders.basebuilder)

Builder Base Classes

class regolith.builders.basebuilder.BuilderBase(rc)[source]

Base class for builders

build()[source]

Build the thing that is being built, note this runs all commands listed in self.cmds

construct_global_ctx()[source]

Constructs the global context

render(tname, fname, **kwargs)[source]

Render the template into a file using the kwargs and global context

Parameters:

  • tname (str) – Template name

  • fname (str) – Resulting file name

  • kwargs (dict) – Additional kwargs to the renderer

class regolith.builders.basebuilder.LatexBuilderBase(rc)[source]

Base class for Latex builders

build()

Build the thing that is being built, note this runs all commands listed in self.cmds

clean()[source]

Remove files created by latex

construct_global_ctx()[source]

Constructs the global context

pdf(base)[source]

Compiles latex files to PDF

render(tname, fname, **kwargs)

Render the template into a file using the kwargs and global context

Parameters:

  • tname (str) – Template name

  • fname (str) – Resulting file name

  • kwargs (dict) – Additional kwargs to the renderer

run(cmd)[source]

Run command in build dir