docdown package

Subpackages

• docdown.template_adapters package
  • Submodules
  • docdown.template_adapters.pystache module
  • docdown.template_adapters.string_format module
  • docdown.template_adapters.template_string module
  • Module contents

Submodules

docdown.docdown module

class docdown.docdown.TemplateRenderMixin(template_adapter=u'', *args, **kwargs)

Bases: object

Mixin for extensions which render templates as part of their output

get_template_adapter()

docdown.include module

class docdown.include.IncludeExtension(**kwargs)

Bases: markdown.extensions.Extension

extendMarkdown(md, md_globals)

Add IncludePreprocessor to the Markdown instance.

class docdown.include.IncludePreprocessor(root_directory=u'', current_directory=u'', asset_directory=u'', extension_map=None, **kwargs)

Bases: markdown.preprocessors.Preprocessor

build_csv_table(file_path)

find_file_path(file_name)

Find path to the file within self.root_directory

Start at self.current_directory/self.asset_directory/file_name looking for file_name. Recursively strip one directory level off of self.current_directory to see if self.asset_directory/file_name exists there up until the path matched self.root_directory

handle_code(file_path, file_extension)

Parse source code lines

handle_csv(file_path)

Parse csv file and return as an html table

run(lines)

docdown.include.makeExtension(*args, **kwargs)

docdown.links module

class docdown.links.DocDownLinkPattern(link_map=None, **kwargs)

Bases: markdown.inlinepatterns.LinkPattern

sanitize_url(url)

class docdown.links.LinksExtension(**kwargs)

Bases: markdown.extensions.Extension

extendMarkdown(md, md_globals)

docdown.links.makeExtension(*args, **kwargs)

docdown.media module

class docdown.media.MediaExtension(**kwargs)

Bases: markdown.extensions.Extension

extendMarkdown(md, md_globals)

Add MediaTreeprocessor to the Markdown instance.

class docdown.media.MediaTreeprocessor(media_url=None, **kwargs)

Bases: markdown.treeprocessors.Treeprocessor

run(root)

docdown.media.makeExtension(*args, **kwargs)

docdown.note_blocks module

note_blocks

docdown.note_blocks Markdown extension module

class docdown.note_blocks.NoteBlockPreprocessor(prefix=u'', postfix=u'', tags=None, template_adapter=u'docdown.template_adapters.StringFormatAdapter', default_tag=u'', **kwargs)

Bases: docdown.docdown.TemplateRenderMixin, markdown.preprocessors.Preprocessor

RE = <_sre.SRE_Pattern object>

run(lines)

class docdown.note_blocks.NoteExtension(**kwargs)

Bases: markdown.extensions.Extension

Renders a block of HTML with a title, svg image, and content to be displayed as a note. The svg image is rendered using.

Configuration Example: {

‘template_adapter’: ‘docdown.template_adapters.StringFormatAdapter’, ‘prefix’: (‘<div class=”{ tag }”>’

‘ <div class=”icon”>’ ‘ {% svg “{ svg }” %}’ ‘ <img class=”icon–pdf” src=”{% static “{ svg_path }” %}”’ ‘ </div>’ ‘ <h5>{ title }</h5>’ ‘</div>’),

‘postfix’: ‘</div>’, ‘tags’: {

‘tag_name’: {

‘svg’: ‘standard/icon-must’, ‘svg_path’: ‘svg/standard/icon-must.svg’, ‘title’: ‘Must’

},

}

}

extendMarkdown(md, md_globals)

Add NoteBlockPreprocessor to the Markdown instance.

docdown.note_blocks.makeExtension(*args, **kwargs)

docdown.platform_section module

platform_section

docdown.platform_section Markdown extension module

class docdown.platform_section.PlatformSectionExtension(**kwargs)

Bases: markdown.extensions.Extension

Renders a block of content if and only if the configured platform section is in the DocDown tag’s list of platform sections.

Configuration Example: {

‘platform_section’: ‘Android’,

}

extendMarkdown(md, md_globals)

Add NoteBlockPreprocessor to the Markdown instance.

class docdown.platform_section.PlatformSectionPreprocessor(platform_section, **kwargs)

Bases: markdown.preprocessors.Preprocessor

RE = <_sre.SRE_Pattern object>

run(lines)

docdown.platform_section.makeExtension(*args, **kwargs)

docdown.sequence module

class docdown.sequence.SequenceDiagramBlockPreprocessor(media_url=None, prefix=u'', postfix=u'', template_adapter=u'docdown.template_adapters.StringFormatAdapter', **kwargs)

Bases: docdown.docdown.TemplateRenderMixin, markdown.preprocessors.Preprocessor

RE = <_sre.SRE_Pattern object>

run(lines)

class docdown.sequence.SequenceDiagramExtension(**kwargs)

Bases: markdown.extensions.Extension

extendMarkdown(md, md_globals)

Add SequenceDiagramBlockPreprocessor to the Markdown instance.

docdown.sequence.makeExtension(*args, **kwargs)

Module contents