From a4f6cbe9aaaff41252ef7ceccc082d22f2256872 Mon Sep 17 00:00:00 2001 From: xgui3783 <xgui3783@gmail.com> Date: Tue, 23 Jun 2020 14:38:00 +0200 Subject: [PATCH] bugfix: read the docs (#546) * Create .readthedocs.yml * Create doc-requirements.txt --- .readthedocs.yml | 23 +++++++++++++++++++++++ doc-requirements.txt | 3 +++ 2 files changed, 26 insertions(+) create mode 100644 .readthedocs.yml create mode 100644 doc-requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..8f70f5c03 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,23 @@ +# .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 with Sphinx +# sphinx: +# configuration: docs/conf.py + +# Build documentation with MkDocs +mkdocs: + configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.7 + install: + - requirements: docs-requirements.txt diff --git a/doc-requirements.txt b/doc-requirements.txt new file mode 100644 index 000000000..ccba8f4dc --- /dev/null +++ b/doc-requirements.txt @@ -0,0 +1,3 @@ +mkdocs>=1.1,<2 +mkdocs-material +mdx_truly_sane_lists -- GitLab