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)

author_login (chango.action.ParentPullRequest attribute) author_uid (chango.concrete.sections.GitHubSectionChangeNote.get_author_url parameter) (chango.concrete.sections.SectionChangeNote.get_author_url parameter) author_uids (chango.concrete.sections.PullRequest attribute) (chango.concrete.sections.PullRequest parameter)

B

BackwardCompatibleChanGo (class in chango.concrete) BackwardCompatibleVersionScanner (class in chango.concrete) base_directory (chango.concrete.DirectoryVersionScanner attribute) (chango.concrete.DirectoryVersionScanner parameter) build_from_github_event() (chango.abc.ChangeNote class method) (chango.concrete.CommentChangeNote class method) (chango.concrete.sections.GitHubSectionChangeNote class method) build_github_event_change_note() (chango.abc.ChanGo method) (chango.concrete.BackwardCompatibleChanGo method) (chango.concrete.DirectoryChanGo method)

build_template() (chango.abc.ChangeNote class method) build_template_change_note() (chango.abc.ChanGo method) (chango.concrete.BackwardCompatibleChanGo method) build_version_history() (chango.abc.ChanGo method) (chango.concrete.BackwardCompatibleChanGo method) build_version_note() (chango.abc.ChanGo method) (chango.concrete.BackwardCompatibleChanGo method) (chango.concrete.DirectoryChanGo 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.action module chango.concrete module chango.concrete.sections 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 ChanGoActionData (class in chango.action) ChanGoConfig (class in chango.config) ChanGoError ChanGoInstanceConfig (class in chango.config) closes_threads (chango.concrete.sections.PullRequest attribute) (chango.concrete.sections.PullRequest parameter) comment (chango.concrete.CommentChangeNote attribute) (chango.concrete.CommentChangeNote parameter) CommentChangeNote (class in chango.concrete) CommentVersionNote (class in chango.concrete) configuration value chango_pyproject_toml context (chango.concrete.sections.GitHubSectionChangeNote.model_post_init parameter) (chango.concrete.sections.SectionChangeNote.model_post_init parameter) CREOLE (chango.constants.MarkupLanguage attribute)

D

data (chango.abc.ChangeNote.build_from_github_event parameter) (chango.abc.ChangeNote.from_bytes parameter) (chango.abc.ChanGo.build_github_event_change_note 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.concrete.sections.SectionChangeNote class method) (chango.constants.MarkupLanguage class method)

G

get_author_url() (chango.concrete.sections.GitHubSectionChangeNote class method) (chango.concrete.sections.SectionChangeNote class method) 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.BackwardCompatibleVersionScanner method) (chango.concrete.DirectoryVersionScanner method)

get_pull_request_url() (chango.concrete.sections.GitHubSectionChangeNote class method) (chango.concrete.sections.SectionChangeNote class method) get_sections() (chango.concrete.sections.GitHubSectionChangeNote class method) get_thread_url() (chango.concrete.sections.GitHubSectionChangeNote class method) (chango.concrete.sections.SectionChangeNote class method) get_version() (chango.abc.VersionScanner method) get_write_directory() (chango.abc.ChanGo method) (chango.concrete.BackwardCompatibleChanGo method) GitHubSectionChangeNote (class in chango.concrete.sections)

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) is_required (chango.concrete.sections.Section attribute) (chango.concrete.sections.Section parameter)

issue_type (chango.action.LinkedIssue attribute) (chango.action.LinkedIssue parameter) issue_types (chango.concrete.sections.GitHubSectionChangeNote.get_sections parameter)

L

labels (chango.action.LinkedIssue attribute) (chango.action.LinkedIssue parameter) (chango.concrete.sections.GitHubSectionChangeNote.get_sections parameter) legacy_instances (chango.concrete.BackwardCompatibleChanGo parameter) linked_issues (chango.action.ChanGoActionData attribute) (chango.action.ChanGoActionData parameter) LinkedIssue (class in chango.action)

load() (chango.config.ChanGoConfig class method) load_change_note() (chango.abc.ChanGo method) (chango.concrete.BackwardCompatibleChanGo method) load_version_history() (chango.abc.ChanGo method) load_version_note() (chango.abc.ChanGo method) lookup_change_note() (chango.abc.VersionScanner method) (chango.concrete.BackwardCompatibleVersionScanner method)

M

main_instance (chango.concrete.BackwardCompatibleChanGo parameter) 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) MARKUP (chango.concrete.sections.SectionChangeNote attribute) MarkupLanguage (class in chango.constants) MEDIAWIKI (chango.constants.MarkupLanguage attribute) model_post_init() (chango.concrete.sections.GitHubSectionChangeNote method) (chango.concrete.sections.SectionChangeNote method)

module chango chango.abc chango.action chango.concrete chango.concrete.sections chango.config chango.constants chango.error chango.helpers chango.sphinx_ext module (chango.config.ChanGoInstanceConfig attribute) (chango.config.ChanGoInstanceConfig parameter)

N

name (chango.concrete.sections.SectionChangeNote.with_sections parameter) (chango.config.ChanGoInstanceConfig attribute) (chango.config.ChanGoInstanceConfig parameter)

number (chango.action.LinkedIssue attribute) (chango.action.LinkedIssue parameter) (chango.action.ParentPullRequest attribute) (chango.action.ParentPullRequest parameter)

O

obj (chango.helpers.ensure_uid parameter)

ORG (chango.constants.MarkupLanguage attribute) OWNER (chango.concrete.sections.GitHubSectionChangeNote attribute)

P

package (chango.config.ChanGoInstanceConfig attribute) (chango.config.ChanGoInstanceConfig parameter) parent_pull_request (chango.action.ChanGoActionData attribute) (chango.action.ChanGoActionData parameter) ParentPullRequest (class in chango.action) path (chango.config.ChanGoConfig.load parameter) (chango.config.get_chango_instance parameter)

POD (chango.constants.MarkupLanguage attribute) pr_uid (chango.concrete.sections.SectionChangeNote.get_pull_request_url parameter) pull_requests (chango.concrete.sections.SectionChangeNote attribute) (chango.concrete.sections.SectionChangeNote parameter) PullRequest (class in chango.concrete.sections)

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) (chango.concrete.sections.SectionVersionNote method)

render_pr_details (chango.concrete.sections.Section attribute) (chango.concrete.sections.Section parameter) REPOSITORY (chango.concrete.sections.GitHubSectionChangeNote attribute) RESTRUCTUREDTEXT (chango.constants.MarkupLanguage attribute)

S

scanner (chango.abc.ChanGo property) (chango.concrete.BackwardCompatibleChanGo property) (chango.concrete.DirectoryChanGo parameter) scanners (chango.concrete.BackwardCompatibleVersionScanner parameter) Section (class in chango.concrete.sections) section_change_note_type (chango.concrete.sections.SectionVersionNote parameter) SectionChangeNote (class in chango.concrete.sections) SECTIONS (chango.concrete.sections.SectionChangeNote attribute) sections (chango.concrete.sections.SectionChangeNote.with_sections parameter) SectionVersionNote (class in chango.concrete.sections) self (chango.concrete.sections.GitHubSectionChangeNote.model_post_init parameter) (chango.concrete.sections.SectionChangeNote.model_post_init 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) (chango.concrete.sections.SectionChangeNote.from_string parameter)

sort_order (chango.concrete.sections.Section attribute) (chango.concrete.sections.Section parameter) start_from (chango.abc.ChanGo.load_version_history parameter) (chango.abc.VersionScanner.get_available_versions parameter) state (chango.action.ParentPullRequest attribute) (chango.action.ParentPullRequest parameter) string (chango.abc.ChangeNote.from_string parameter) (chango.concrete.sections.SectionChangeNote.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) thread_uid (chango.concrete.sections.SectionChangeNote.get_thread_url parameter) title (chango.action.LinkedIssue attribute) (chango.action.LinkedIssue parameter) (chango.action.ParentPullRequest attribute) (chango.action.ParentPullRequest parameter) (chango.concrete.sections.Section attribute) (chango.concrete.sections.Section parameter)

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.ChangeNote.update_uid 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.concrete.BackwardCompatibleVersionScanner.lookup_change_note parameter) (chango.concrete.sections.PullRequest attribute) (chango.concrete.sections.PullRequest parameter) (chango.concrete.sections.Section attribute) (chango.concrete.sections.Section parameter) (chango.concrete.sections.SectionChangeNote.from_string parameter) (chango.Version attribute) (chango.Version parameter)

unreleased_directory (chango.concrete.DirectoryVersionScanner attribute) (chango.concrete.DirectoryVersionScanner parameter) UnsupportedMarkupError update_uid() (chango.abc.ChangeNote method) url (chango.action.ParentPullRequest attribute) (chango.action.ParentPullRequest parameter)

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

with_sections() (chango.concrete.sections.SectionChangeNote class method)

write_change_note() (chango.abc.ChanGo method)