feat: add readthedocs config (#303)

.readthedocs.yaml

@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# 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
+   # TODO: Fix autodoc warnings and set this to true. See https://github.com/openedx/edx-django-utils/issues/304
+   fail_on_warning: false
+
+python:
+   version: 3.8
+   install:
+   - requirements: requirements/doc.txt

setup.py

@@ -108,6 +108,7 @@ def is_requirement(line):
     version=VERSION,
     description="""EdX utilities for Django Application development.""",
     long_description=README + '\n\n' + CHANGELOG,
+    long_description_content_type="text/x-rst",
     author='edX',
     author_email='[email protected]',
     url='https://github.com/openedx/edx-django-utils',