Disseminate

Document Processing

• Features: Basic
• Features: Advanced
• Quickstart

Installation

• MacOS (Homebrew)
• MacOS (Pip)
• Linux (Pip)

Markup Language

• Header
• Tags
• Macros

Projects

• Documents
• Templates

Interfaces

• Command-line

Development

• API Documentation
  • Attributes
  • Builders
  • Checkers
  • CLI
  • Contexts
  • Document
  • Formats
  • Label Manager
  • Paths
  • Server
  • Signals
  • Tags
  • Utilities
• Release Notes

• Index

Receivers

Receivers for TargetBuilders

disseminate.builders.target_builders.receivers.add_file(parameters, context, in_ext, target, use_cache=False)

Add a file to the target builder.

Parameters

parametersUnion[str, List[str, pathlib.Path]]

The parameters for the build

contextBaseContext

The document context dict

in_extstr

The extension for the file.

targetstr

The document target to add the file for.

use_cacheOptional[bool]

If True, use cached paths when adding files.

Returns

outfilepathpathlib.Path

The outfilepath for the file from the build.

disseminate.builders.target_builders.receivers.add_target_builders(root_document)

Add target builders to a document context

disseminate.builders.target_builders.receivers.build(document, complete=True)

Build a document tree’s targets (and subdocuments) using the target builders.

disseminate.builders.target_builders.receivers.build_needed(document)

Evaluate whether any of the target builders need to be build

disseminate.builders.target_builders.receivers.find_builder(context, target=None, **kwargs)

Find a target builder in a document context, or None if None was found.

Parameters

contextdocument.DocumentContext

The context dict for the document.

targetOptional[str]

The target to retrieve the target builder for.

Returns

buildersList[builders.target_builders.TargetBuilder]

Returns a list of all matching target builders.