mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-20 21:18:32 +02:00
fix readthedocs.io build process
This commit is contained in:
parent
f86d923843
commit
cafaaec9d4
4 changed files with 26 additions and 0 deletions
1
docs/index.md
Normal file
1
docs/index.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
{!README.md!}
|
2
docs/requirements.txt
Normal file
2
docs/requirements.txt
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
mkdocs==1.1
|
||||||
|
markdown-include==0.5.1
|
|
@ -10,6 +10,7 @@ extra_css:
|
||||||
- assets/highlight.css
|
- assets/highlight.css
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- admonition
|
- admonition
|
||||||
|
- markdown_include.include
|
||||||
repo_url: https://github.com/jrnl-org/jrnl/
|
repo_url: https://github.com/jrnl-org/jrnl/
|
||||||
site_author: Manuel Ebert
|
site_author: Manuel Ebert
|
||||||
site_description: Collect your thoughts and notes without leaving the command line.
|
site_description: Collect your thoughts and notes without leaving the command line.
|
||||||
|
|
22
readthedocs.yml
Normal file
22
readthedocs.yml
Normal file
|
@ -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
|
Loading…
Add table
Reference in a new issue