Commit Graph

12 Commits (main)

Author SHA1 Message Date
Andrew Cassidy acedf2b401 Update docs 3 years ago
Andrew Cassidy 66bc8509e3 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.
3 years ago
Andrew Cassidy 66baa96f44 Reflect last change in documentation 3 years ago
Andrew Cassidy affb8f8627 Configure rtd 3 years ago
Andrew Cassidy a925a4e420 walk back last change slightly
preamble now contains the title, to allow for representing Jekyll front matter or any other information above the title
3 years ago
Andrew Cassidy a230968736 `header` attribute on the changelog class has been split into `title` and `preamble` 3 years ago
Andrew Cassidy 4b11ab839d Add explanation of changelog file format 3 years ago
Andrew Cassidy ac3fb0ca2b Handbook section with usage information 3 years ago
Andrew Cassidy 36ab0930fe Add API documentation 3 years ago
Andrew Cassidy f085f318b3 Add API documentation 3 years ago
Andrew Cassidy 5cc815d8b6 Styling and layout for docs 3 years ago
Andrew Cassidy a8fab8149c Initialize docs 3 years ago