mirror of
https://github.com/drewcassidy/yaclog.git
synced 2024-09-01 14:58:58 +00:00
Configure rtd
This commit is contained in:
parent
dacacdc496
commit
affb8f8627
23
.readthedocs.yaml
Normal file
23
.readthedocs.yaml
Normal file
@ -0,0 +1,23 @@
|
||||
# .readthedocs.yaml
|
||||
# Read the Docs configuration file
|
||||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
||||
|
||||
# Required
|
||||
version: 2
|
||||
|
||||
# Build documentation in the docs/ directory with Sphinx
|
||||
sphinx:
|
||||
configuration: docs/conf.py
|
||||
|
||||
# Optionally build your docs in additional formats such as PDF
|
||||
formats:
|
||||
- pdf
|
||||
|
||||
# Optionally set the version of Python and requirements required to build your docs
|
||||
python:
|
||||
version: 3.8
|
||||
install:
|
||||
- method: pip
|
||||
path: .
|
||||
extra_requirements:
|
||||
- docs
|
@ -1,6 +1,6 @@
|
||||
# Changelog Files
|
||||
|
||||
Yaclog works on markdown changelog files, using a machine-readable format based on what is proposed by [Keep a Changelog](https://keepachangelog.com). Changelog files can be created using the {command}`yaclog init` command.
|
||||
Yaclog works on Markdown changelog files, using a machine-readable format based on what is proposed by [Keep a Changelog](https://keepachangelog.com). Changelog files can be created using the {command}`yaclog init` command.
|
||||
|
||||
## Preamble
|
||||
|
||||
@ -37,7 +37,7 @@ Tags are additional metadata added to a version header, denoted by all-caps text
|
||||
```markdown
|
||||
# Changelog
|
||||
|
||||
This is the changelog for my cool project!
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## 0.13.0 "Aquarius" - 1970-04-11 [YANKED]
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user