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

Handlers

class disseminate.server.handlers.CheckerHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

Bases: disseminate.server.handlers.server.ServerHandler

A request handler for the dependency checkers

checker_to_dict(item, required=True, level=1)

Convert checkers into a list of dicts suitable for rendering the view.

class disseminate.server.handlers.CustomStaticFileHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

Bases: disseminate.server.handlers.server.ServerHandler, tornado.web.StaticFileHandler

A custom static file handler that handles rendered error pages

class disseminate.server.handlers.PygmentizeHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

Bases: disseminate.server.handlers.server.ServerHandler

A handler to pygmentize source files

class disseminate.server.handlers.ServerHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

Bases: tornado.web.RequestHandler

A request handler for server functions

get_template_path()

The template path for the server templates

set_default_headers()

Override this to set HTTP headers at the beginning of the request.

For example, this is the place to set a custom Server header. Note that setting such headers in the normal flow of request processing may not do what you want, since headers may be reset during error handling.

write_error(status_code, **kwargs)

Render custom error pages

class disseminate.server.handlers.SignalHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

Bases: disseminate.server.handlers.server.ServerHandler

A request handler for the signals

signals_to_dict(signal_namespace)

Given a list of processor classes, prepare a list of dicts listing the sub-processors Parameters ———- signal_namespace : signals.signals.Namespace

class disseminate.server.handlers.TreeHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

Bases: disseminate.server.handlers.server.ServerHandler

A request handler for the project document tree

tree_to_dict(docs, level=1)

Convert the root documents into a list of dicts, suitable for rendering in the view.