yaclog/docs/index.md

# Yaclog: Yet Another Commandline Changelog Tool

[![Documentation Status](https://readthedocs.org/projects/yaclog/badge/?version=latest)](https://yaclog.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml/badge.svg)](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml)
[![PyPI version](https://badge.fury.io/py/yaclog.svg)](https://badge.fury.io/py/yaclog)

Yaclog is a python library and command line tool to make it easier to keep track of changes to your projects.
It includes commands for appending new changes to a markdown changelog file, as well as releasing new versions
for deployment via git tags.

```{toctree}
---
maxdepth: 2
caption: Contents
---

handbook/index
reference/index
```

```{toctree}
---
maxdepth: 1
---

Changelog <changelog>
License <license>
```

## Indices and tables

* {ref}`genindex`
* {ref}`modindex`
* {ref}`search`
Version 1.0.0 ### Changed - API changes: - `header` attribute renamed to `preamble` to avoid confusion. - improved version header parsing to be more robust and handle multi-word version names. - improved version number incrementing in `release`. - can now handle other text surrounding a pep440-compliant version number, which will not be modified - can now handle pre-releases correctly. The version to increment is the most recent version in the log with a valid pep440 version number in it. - Release increment and prerelease increments can be mixed, allowing e.g: `yaclog release -mr` to create a release candidate with in incremented minor version number. - `release` base version is now an argument instead of an option, for consistency with other commands. ### Removed - `entry` with multiple `-b` options no longer add sub bullet points, instead adding each bullet as its own line. ### Added - Terminal output has color to distinguish version names/headers, sections, and git information. - Extra newlines are added between versions to improve readability of the raw markdown file. 2021-05-07 21:52:28 +00:00			`# Yaclog: Yet Another Commandline Changelog Tool`

			`[![Documentation Status](https://readthedocs.org/projects/yaclog/badge/?version=latest)](https://yaclog.readthedocs.io/en/latest/?badge=latest)`
			`[![Build Status](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml/badge.svg)](https://github.com/drewcassidy/yaclog/actions/workflows/python-publish.yml)`
			`[![PyPI version](https://badge.fury.io/py/yaclog.svg)](https://badge.fury.io/py/yaclog)`
Handbook section with usage information 2021-05-05 09:37:20 +00:00
			`Yaclog is a python library and command line tool to make it easier to keep track of changes to your projects.`
			`It includes commands for appending new changes to a markdown changelog file, as well as releasing new versions`
			`for deployment via git tags.`

			```{toctree}
			`---`
			`maxdepth: 2`
			`caption: Contents`
			`---`

			`handbook/index`
			`reference/index`
			```

			```{toctree}
			`---`
			`maxdepth: 1`
			`---`

			`Changelog <changelog>`
			`License <license>`
			```

			`## Indices and tables`

			* {ref}`genindex`
			* {ref}`modindex`
			* {ref}`search`