Index

Symbols

--date chango-release command line option --edit chango-new command line option --install-completion chango command line option --markup chango-report-history command line option chango-report-version command line option --no-edit chango-new command line option --output chango-report-history command line option chango-report-version command line option --path chango-config command line option --show-completion chango command line option

--slug chango-new command line option --uid chango-release command line option chango-report-version command line option --version chango command line option -e chango-new command line option -m chango-report-history command line option chango-report-version command line option -ne chango-new command line option -o chango-report-history command line option chango-report-version command line option -s chango-new command line option

_

__version__ (in module chango)

A

add_change_note() (chango.abc.VersionNote method) add_version_note() (chango.abc.VersionHistory method)

app (chango.sphinx_ext.setup parameter) ASCIIDOC (chango.constants.MarkupLanguage attribute)

B

base_directory (chango.concrete.DirectoryVersionScanner attribute) (chango.concrete.DirectoryVersionScanner parameter) build_from_github_event() (chango.abc.ChangeNote class method) (chango.concrete.CommentChangeNote class method) build_github_event_change_note() (chango.abc.ChanGo method) (chango.concrete.DirectoryChanGo method)

build_template() (chango.abc.ChangeNote class method) build_template_change_note() (chango.abc.ChanGo method) build_version_history() (chango.abc.ChanGo method) build_version_note() (chango.abc.ChanGo method)

C

change_note (chango.abc.ChanGo.get_write_directory parameter) (chango.abc.ChanGo.write_change_note parameter) (chango.abc.VersionNote.add_change_note parameter) (chango.abc.VersionNote.remove_change_note parameter) change_note_type (chango.concrete.DirectoryChanGo parameter) change_uid_from_file() (in module chango.helpers) ChangeNote (class in chango.abc) ChangeNoteInfo (class in chango) chango module ChanGo (class in chango.abc) chango (directive) chango command line option --install-completion --show-completion --version chango-config command line option --path chango-edit command line option UID chango-new command line option --edit --no-edit --slug -e -ne -s chango-release command line option --date --uid chango-report-history command line option --markup --output -m -o

chango-report-version command line option --markup --output --uid -m -o chango.abc module chango.concrete module chango.config module chango.constants module chango.error module chango.helpers module chango.sphinx_ext module chango_instance (chango.config.ChanGoConfig attribute) (chango.config.ChanGoConfig parameter) chango_pyproject_toml configuration value ChanGoConfig (class in chango.config) ChanGoError ChanGoInstanceConfig (class in chango.config) comment (chango.concrete.CommentChangeNote attribute) (chango.concrete.CommentChangeNote parameter) CommentChangeNote (class in chango.concrete) CommentVersionNote (class in chango.concrete) configuration value chango_pyproject_toml CREOLE (chango.constants.MarkupLanguage attribute)

D

data (chango.abc.ChangeNote.from_bytes parameter) date (chango.abc.VersionNote property) (chango.Version attribute) (chango.Version parameter) directory (chango.abc.ChangeNote.to_file parameter)

directory_format (chango.concrete.DirectoryChanGo attribute) (chango.concrete.DirectoryChanGo parameter) directory_pattern (chango.concrete.DirectoryVersionScanner attribute) (chango.concrete.DirectoryVersionScanner parameter) DirectoryChanGo (class in chango.concrete) DirectoryVersionScanner (class in chango.concrete)

E

encoding (chango.abc.ChangeNote.from_bytes parameter) (chango.abc.ChangeNote.from_file parameter) (chango.abc.ChangeNote.to_bytes parameter) (chango.abc.ChangeNote.to_file parameter) (chango.abc.ChangeNote.to_string parameter) (chango.abc.ChanGo.write_change_note parameter)

end_at (chango.abc.ChanGo.load_version_history parameter) (chango.abc.VersionScanner.get_available_versions parameter) ensure_uid() (in module chango.helpers) event (chango.abc.ChangeNote.build_from_github_event parameter) (chango.abc.ChanGo.build_github_event_change_note parameter)

F

file (chango.helpers.change_uid_from_file parameter) file_extension (chango.abc.ChangeNote property) file_name (chango.abc.ChangeNote property) file_path (chango.abc.ChangeNote.from_file parameter) (chango.ChangeNoteInfo attribute) (chango.ChangeNoteInfo parameter)

from_bytes() (chango.abc.ChangeNote class method) from_file() (chango.abc.ChangeNote class method) from_string() (chango.abc.ChangeNote class method) (chango.constants.MarkupLanguage class method)

G

get_available_versions() (chango.abc.VersionScanner method) (chango.concrete.DirectoryVersionScanner method) get_changes() (chango.abc.VersionScanner method) get_chango_instance() (in module chango.config)

get_latest_version() (chango.abc.VersionScanner method) (chango.concrete.DirectoryVersionScanner method) get_version() (chango.abc.VersionScanner method) get_write_directory() (chango.abc.ChanGo method)

H

has_unreleased_changes() (chango.abc.VersionScanner method) (chango.concrete.DirectoryVersionScanner method)

HeaderVersionHistory (class in chango.concrete) HTML (chango.constants.MarkupLanguage attribute)

I

import_chango_instance() (chango.config.ChanGoConfig method)

invalidate_caches() (chango.abc.VersionScanner method) is_available() (chango.abc.VersionScanner method)

L

load() (chango.config.ChanGoConfig class method) load_change_note() (chango.abc.ChanGo method)

load_version_history() (chango.abc.ChanGo method) load_version_note() (chango.abc.ChanGo method) lookup_change_note() (chango.abc.VersionScanner method)

M

mapping (chango.constants.MarkupLanguage.from_string parameter) MARKDOWN (chango.constants.MarkupLanguage attribute) markup (chango.abc.VersionHistory.render parameter) (chango.abc.VersionNote.render parameter) MARKUP (chango.concrete.CommentChangeNote attribute) markup (chango.concrete.CommentVersionNote.render parameter) (chango.concrete.HeaderVersionHistory.render parameter) MarkupLanguage (class in chango.constants) MEDIAWIKI (chango.constants.MarkupLanguage attribute) module chango chango.abc chango.concrete chango.config chango.constants chango.error chango.helpers chango.sphinx_ext

module (chango.config.ChanGoInstanceConfig attribute) (chango.config.ChanGoInstanceConfig parameter)

N

name (chango.config.ChanGoInstanceConfig attribute) (chango.config.ChanGoInstanceConfig parameter)

O

obj (chango.helpers.ensure_uid parameter)

ORG (chango.constants.MarkupLanguage attribute)

P

package (chango.config.ChanGoInstanceConfig attribute) (chango.config.ChanGoInstanceConfig parameter)

path (chango.config.ChanGoConfig.load parameter) (chango.config.get_chango_instance parameter) POD (chango.constants.MarkupLanguage attribute)

R

RDOC (chango.constants.MarkupLanguage attribute) release() (chango.abc.ChanGo method) remove_change_note() (chango.abc.VersionNote method) remove_version_note() (chango.abc.VersionHistory method)

render() (chango.abc.VersionHistory method) (chango.abc.VersionNote method) (chango.concrete.CommentVersionNote method) (chango.concrete.HeaderVersionHistory method) RESTRUCTUREDTEXT (chango.constants.MarkupLanguage attribute)

S

scanner (chango.abc.ChanGo property) (chango.concrete.DirectoryChanGo parameter) setup() (in module chango.sphinx_ext) slug (chango.abc.ChangeNote parameter) (chango.abc.ChangeNote property) (chango.abc.ChangeNote.build_template parameter) (chango.abc.ChangeNote.from_bytes parameter) (chango.abc.ChangeNote.from_string parameter) (chango.abc.ChanGo.build_template_change_note parameter)

start_from (chango.abc.ChanGo.load_version_history parameter) (chango.abc.VersionScanner.get_available_versions parameter) string (chango.abc.ChangeNote.from_string parameter) (chango.constants.MarkupLanguage.from_string parameter) sys_path (chango.config.ChanGoConfig attribute) (chango.config.ChanGoConfig parameter)

T

TEXT (chango.constants.MarkupLanguage attribute) TEXTILE (chango.constants.MarkupLanguage attribute)

to_bytes() (chango.abc.ChangeNote method) to_file() (chango.abc.ChangeNote method) to_string() (chango.abc.ChangeNote method)

U

UID chango-edit command line option uid (chango.abc.ChangeNote parameter) (chango.abc.ChangeNote property) (chango.abc.ChangeNote.build_template parameter) (chango.abc.ChangeNote.from_bytes parameter) (chango.abc.ChangeNote.from_string parameter) (chango.abc.ChanGo.build_template_change_note parameter) (chango.abc.ChanGo.load_change_note parameter) (chango.abc.VersionNote property) (chango.abc.VersionScanner.get_changes parameter) (chango.abc.VersionScanner.get_version parameter) (chango.abc.VersionScanner.is_available parameter) (chango.abc.VersionScanner.lookup_change_note parameter) (chango.ChangeNoteInfo attribute) (chango.ChangeNoteInfo parameter) (chango.Version attribute) (chango.Version parameter)

unreleased_directory (chango.concrete.DirectoryVersionScanner attribute) (chango.concrete.DirectoryVersionScanner parameter) UnsupportedMarkupError

V

ValidationError version (chango.abc.ChanGo.build_version_note parameter) (chango.abc.ChanGo.get_write_directory parameter) (chango.abc.ChanGo.load_version_note parameter) (chango.abc.ChanGo.release parameter) (chango.abc.ChanGo.write_change_note parameter) (chango.abc.VersionNote attribute) (chango.abc.VersionNote parameter) (chango.ChangeNoteInfo attribute) (chango.ChangeNoteInfo parameter)

Version (class in chango) version_history_type (chango.concrete.DirectoryChanGo parameter) version_note (chango.abc.VersionHistory.add_version_note parameter) (chango.abc.VersionHistory.remove_version_note parameter) version_note_type (chango.concrete.DirectoryChanGo parameter) VersionHistory (class in chango.abc) VersionNote (class in chango.abc) VersionScanner (class in chango.abc)

W

write_change_note() (chango.abc.ChanGo method)