From 9d8c573c6464b904c1848163acd561bf806db524 Mon Sep 17 00:00:00 2001 From: Rebecca Graber Date: Thu, 27 Apr 2023 13:45:10 -0400 Subject: [PATCH 1/5] feat: add readthedocs config --- readthedocs.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 readthedocs.yaml diff --git a/readthedocs.yaml b/readthedocs.yaml new file mode 100644 index 00000000..19a69237 --- /dev/null +++ b/readthedocs.yaml @@ -0,0 +1,16 @@ +# .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 + fail_on_warning: true + +python: + version: 3.8 + install: + - requirements: requirements/doc.txt From 12bc5a38b62eb442e6ff5f6d992729d922f59f68 Mon Sep 17 00:00:00 2001 From: Rebecca Graber Date: Thu, 27 Apr 2023 13:51:00 -0400 Subject: [PATCH 2/5] fixup!: rename --- readthedocs.yaml => .readthedocs.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename readthedocs.yaml => .readthedocs.yaml (100%) diff --git a/readthedocs.yaml b/.readthedocs.yaml similarity index 100% rename from readthedocs.yaml rename to .readthedocs.yaml From aedb09a03011884ff5136d44378ce76d1ac21d20 Mon Sep 17 00:00:00 2001 From: Rebecca Graber Date: Thu, 27 Apr 2023 13:59:26 -0400 Subject: [PATCH 3/5] fixup!: add long description type --- setup.py | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.py b/setup.py index da9e7b4f..37dd9383 100644 --- a/setup.py +++ b/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='oscm@edx.org', url='https://github.com/openedx/edx-django-utils', From f74ce6753b6230163553c39045f50e51e36d49b0 Mon Sep 17 00:00:00 2001 From: Rebecca Graber Date: Thu, 27 Apr 2023 14:06:47 -0400 Subject: [PATCH 4/5] feat: do not fail on warning --- .readthedocs.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 19a69237..a9362f5d 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,7 +8,8 @@ version: 2 # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py - fail_on_warning: true + # TODO: Fix autodoc warnings and set this to true + fail_on_warning: false python: version: 3.8 From ccf9b656bd71487e2de2f227b830bb713aa2b8bb Mon Sep 17 00:00:00 2001 From: Rebecca Graber Date: Thu, 27 Apr 2023 14:14:36 -0400 Subject: [PATCH 5/5] fixup!: link --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index a9362f5d..f4ad9d82 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,7 +8,7 @@ version: 2 # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py - # TODO: Fix autodoc warnings and set this to true + # TODO: Fix autodoc warnings and set this to true. See https://github.com/openedx/edx-django-utils/issues/304 fail_on_warning: false python: