Config Read the Docs

kakaobrain · Nov 29, 2019 · 0e62ee6 · 0e62ee6
1 parent 00d8ae2
commit 0e62ee6
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,15 @@
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
+version: 2
+
+python:
+  version: 3.6
+  install:
+  - path: .
+    extra_requirements: [docs]
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+formats: all
diff --git a/setup.py b/setup.py
@@ -73,6 +73,7 @@
     install_requires=['torch>=1.1'],
     setup_requires=['pytest-runner'],
     tests_require=['pytest>=4'],
+    extras_require={'docs': ['sphinx>=2.2.1']},
 
     classifiers=[
         'Development Status :: 3 - Alpha',