Integrate readthedocs.io (Samsung#1486)

* Integrate readthedocs.io - Add build configuration for readthedocs. - Add contents.rst Signed-off-by: Sung-Jae Lee <[email protected]>
BalyshevArtem · May 26, 2020 · 6436120 · 6436120
1 parent d020085
commit 6436120
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 0 deletions.
diff --git a/.readthedocs.yml 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: 1.4
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+# 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/contents.rst b/docs/contents.rst
@@ -0,0 +1,29 @@
+.. ONE documentation master file, created by
+   sphinx-quickstart on Thu May 14 18:13:12 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ONE's documentation!
+===============================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+  ./overview/index
+  ./howto/index
+  ./runtime/index
+  ./compiler/index
+  ./common-ir/index
+  ./package/index
+  ./platform/index
+  ./device/index
+  ./test/index
+  ./release/index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+recommonmark
+sphinx-markdown-tables
+sphinx_rtd_theme