API Documentation

Docstring for changelog.py

exception tendril.utils.parsers.changelog.ChangeLogParseError[source]

Bases: Exception

exception tendril.utils.parsers.changelog.ChangeLogNotFoundError[source]

Bases: Exception

class tendril.utils.parsers.changelog.ChangeLogBase[source]

Bases: object

child_marker = None
child_marker_regex = None
child_type = None
has_title = False
_set_title(title)[source]
_check_for_marker(piece)[source]
_populate(mdtree)[source]
_add_child(child)[source]
property title
class tendril.utils.parsers.changelog.ChangeLogChange(mdtree)[source]

Bases: tendril.utils.parsers.changelog.ChangeLogBase

has_title = False
property body
class tendril.utils.parsers.changelog.ChangeLogEntry(mdtree)[source]

Bases: tendril.utils.parsers.changelog.ChangeLogBase

property changes
property initials
property date
_set_title(title)[source]
_populate(mdtree)[source]
class tendril.utils.parsers.changelog.ChangeLogSection(mdtree)[source]

Bases: tendril.utils.parsers.changelog.ChangeLogBase

child_marker = 'paragraph'
child_marker_regex = ''
child_type

alias of ChangeLogEntry

has_title = True
property entries
class tendril.utils.parsers.changelog.ChangeLogPart(mdtree)[source]

Bases: tendril.utils.parsers.changelog.ChangeLogBase

child_marker = 'h3'
child_type

alias of ChangeLogSection

has_title = True
property sections
class tendril.utils.parsers.changelog.ChangeLog(fpath)[source]

Bases: tendril.utils.parsers.changelog.ChangeLogBase

child_marker = 'h2'
child_type

alias of ChangeLogPart

has_title = False
property parts
tendril.utils.parsers.changelog.get_changelog(fpath)[source]