feanil/fix rtd file #419
Merged
feanil/fix rtd file #419
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
dianakhuang
approved these changes
Dec 6, 2023
robrap
reviewed
Dec 6, 2023
| @@ -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.
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?
feanil
force-pushed
the
feanil/fix_rtd_file
branch
from
4e9ebce
to
0bee7d3
Compare
andrey-canon
added a commit
to nelc/event-routing-backends
that referenced
this pull request
Dec 6, 2023
|
[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 |
8 tasks
andrey-canon
added a commit
to nelc/event-routing-backends
that referenced
this pull request
Dec 6, 2023
|
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #416