origen.web.shorthand.shorthand

Functions

• all_from_category(): Undocumented.

• all_include_rsts(): Returns the output files for all RSTs, from all namespaces

• generate(): Updates the shorthand_defs with definitions from the user’s config and

• get(): Retrieves a target

• split_namespace(): Splits a namespaced target into its namespace and target components

origen.web.shorthand.shorthand.all_from_category(category)

origen.web.shorthand.shorthand.all_include_rsts()

Returns the output files for all RSTs, from all namespaces

origen.web.shorthand.shorthand.generate(app)

Updates the shorthand_defs with definitions from the user’s config and generates RST files for all defintion namespaces.

origen.web.shorthand.shorthand.get(target)

Retrieves a target

origen.web.shorthand.shorthand.split_namespace(target)

Splits a namespaced target into its namespace and target components

Classes

• ShorthandDefs: Undocumented.

• Target: Represents a single, unresolved target, in any namespace

class origen.web.shorthand.shorthand.ShorthandDefs(app, opts)

Inheritance

all_from_category(category)

categories = ['extlinks', 'substitutions', 'statics', 'refs', 'docs', 'abslinks', 'api']

Listing of the recognized categories

generate()

Generates the output RST file for this group’s definitions.

get(target)

property output_file

Unless specifically indicated otherwise, use the default namespace’s output dir. Fall back to the app’s source dir otherwise.

class origen.web.shorthand.shorthand.Target(name, category, config, namespace)

Represents a single, unresolved target, in any namespace

Inheritance

generate_substitution(f)

Prints the target’s substitution representation into the given file

property is_abslink

property is_api

property is_doc

property is_extlink

property is_ref

property is_static

property is_sub

property is_substitution