From cafaaec9d4f8991d93f42c39ae5cf273b40545b0 Mon Sep 17 00:00:00 2001 From: Jonathan Wren Date: Sat, 18 Jul 2020 14:11:00 -0700 Subject: [PATCH] fix readthedocs.io build process --- docs/index.md | 1 + docs/requirements.txt | 2 ++ mkdocs.yml | 1 + readthedocs.yml | 22 ++++++++++++++++++++++ 4 files changed, 26 insertions(+) create mode 100644 docs/index.md create mode 100644 docs/requirements.txt create mode 100644 readthedocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..563ed569 --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +{!README.md!} diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..dcb5e78a --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +mkdocs==1.1 +markdown-include==0.5.1 diff --git a/mkdocs.yml b/mkdocs.yml index 409bbd83..3f3a68cf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,6 +10,7 @@ extra_css: - assets/highlight.css markdown_extensions: - admonition + - markdown_include.include repo_url: https://github.com/jrnl-org/jrnl/ site_author: Manuel Ebert site_description: Collect your thoughts and notes without leaving the command line. diff --git a/readthedocs.yml b/readthedocs.yml new file mode 100644 index 00000000..dabbddc7 --- /dev/null +++ b/readthedocs.yml @@ -0,0 +1,22 @@ +# readthedocs.yml +# 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 +mkdocs: + configuration: mkdocs.yml + fail_on_warning: false + +# Optionally build your docs in additional formats such as PDF +formats: + - pdf + - epub + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.7 + install: + - requirements: docs/requirements.txt