-
Notifications
You must be signed in to change notification settings - Fork 23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feanil/fix rtd file #419
feanil/fix rtd file #419
Conversation
There have been requirements changes for this file from the RTD side. Some more details on these changes: https://blog.readthedocs.com/use-build-os-config/ Also we should fail or warnings by default as sphinx warnings generally point out important documentation functionality issues like missing docs or broken links.
@@ -8,8 +8,14 @@ version: 2 | |||
# Build documentation in the docs/ directory with Sphinx | |||
sphinx: | |||
configuration: docs/conf.py | |||
fail_on_warning: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you update https://github.com/openedx/edx-cookiecutters/blob/master/CHANGELOG.rst, and especially note this fail on warning change, in addition to the fixes to read the docs builds?
4e9ebce
to
0bee7d3
Compare
[inform] This might be broken. I had updated edx-drf-extensions to work like edx-platform, and now I tried simplifying the python install to match this cookiecutter update and it broke on Django. See openedx/edx-drf-extensions#415 |
It looks like the failure there is because it's referencing django but not actually including it as a docs requirement and not related to the RTD config. |
Fixes #416