From affb8f862714a62b869893eb37d525463ff80825 Mon Sep 17 00:00:00 2001 From: drewcassidy Date: Fri, 7 May 2021 01:12:30 -0700 Subject: [PATCH] Configure rtd --- .readthedocs.yaml | 23 +++++++++++++++++++++++ docs/handbook/changelog_files.md | 4 ++-- 2 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..76eab0a --- /dev/null +++ b/.readthedocs.yaml @@ -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 \ No newline at end of file diff --git a/docs/handbook/changelog_files.md b/docs/handbook/changelog_files.md index 41b95e6..835c450 100644 --- a/docs/handbook/changelog_files.md +++ b/docs/handbook/changelog_files.md @@ -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]