[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 <[email protected]>
hyperledger-cello · Aug 17, 2019 · a2a3d4b · a2a3d4b
1 parent eb54f14
commit a2a3d4b
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 2 deletions.
diff --git a/.readthedocs.yml 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
@@ -0,0 +1,4 @@
+mkdocs
+mkdocs-material
+pygments
+pymdown-extensions
diff --git 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