-
-
Notifications
You must be signed in to change notification settings - Fork 795
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
replace obsolete m2r with sphinx_mdinclude #1449
base: master
Are you sure you want to change the base?
Conversation
a-detiste
commented
Aug 6, 2024
- PR only contains one change (considered splitting up PR)
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.
thanks
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.
RTD build fails with this change. See https://readthedocs.org/projects/django-oauth-toolkit/builds/25221545/
It replaces the perfeclty fine docutils by an older one that is too old. omnilib/sphinx-mdinclude@db37d3f Downloading docutils-0.18.1-py2.py3-none-any.whl (570 kB) |
The pinned libs are too old. sphinx==7.2.6 |
So please submit an update commit that pins the appropriate versions. the mdinclude version should also be pinned. |
I have absolutely no idea what an "appropriate version" shoud be. I would simply drop pinning altogether & see what happens. |
The usual approach is to upgrade everything and make sure it works. Then pin those versions (pip freeze). |
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.
The point of pinned versions is to avoid future updates that break existing functionality, so a >=
test especially for sphinx which has known compatibility issues between major and minor releases. Please:
- compare what's in docs/requirements.txt with what's in tox.ini. Both are problematic w.r.t. version pinning as it should only be in one place.
- do a
tox -e docs
to test the sphinx build to make sure everything works as expected. - do a
pip freeze
and put the appropriate pinned versions into docs/requirements.txt
Thanks.
@a-detiste thanks for your contribution! Do you have time to wrap up this PR? We'd really like to get it in. |