From a2a3d4be961e2cc166b26cbc3cfa5ac482353656 Mon Sep 17 00:00:00 2001 From: Haitao Yue Date: Sat, 17 Aug 2019 11:34:01 +0800 Subject: [PATCH] [CE-675] Fix rtd build document failed Add .readthedocs.yml config file. Add requirements.txt for doc build. Change-Id: I3423e6352e77166e8bf5c42d95c76b9485a37e3d Signed-off-by: Haitao Yue --- .readthedocs.yml | 24 ++++++++++++++++++++++++ docs/requirements.txt | 4 ++++ mkdocs.yml | 2 -- 3 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 .readthedocs.yml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..438139c63 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,24 @@ +# .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 +mkdocs: + configuration: mkdocs.yml + fail_on_warning: false + +# 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/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..b26dffee3 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +mkdocs +mkdocs-material +pygments +pymdown-extensions diff --git a/mkdocs.yml b/mkdocs.yml index 16a726d4a..fdba557fd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -30,8 +30,6 @@ markdown_extensions: - pymdownx.caret - pymdownx.critic - pymdownx.details - - pymdownx.emoji: - emoji_generator: !!python/name:pymdownx.emoji.to_svg - pymdownx.inlinehilite - pymdownx.keys - pymdownx.magiclink