Move the messages documentation to the user guide #6628
Conversation
|
This will break any existing link to the documentation of individual messages, see for example: I don't think we should do this unless we find a way to fix the redirects for individual message pages. |
Pull Request Test Coverage Report for Build 2345622779
💛 - Coveralls |
See discussion: pylint-dev#6628 (comment) Co-authored-by: Daniël van Noord <[email protected]>
Pierre-Sassoulas
force-pushed
the
cleanup-messages-doc
branch
from
0ba153e to
f15b04b
Compare
Co-authored-by: Daniël van Noord <[email protected]>
See discussion: pylint-dev#6628 (comment) Co-authored-by: Daniël van Noord <[email protected]>
Pierre-Sassoulas
force-pushed
the
cleanup-messages-doc
branch
from
88de942 to
7ade71a
Compare
doc/conf.py
Outdated
| "messages/messages_introduction": "user_guide/messages/index.html", | ||
| "messages/messages_list": "user_guide/messages/messages_overview.html", |
There was a problem hiding this comment.
| "messages/messages_introduction": "user_guide/messages/index.html", | |
| "messages/messages_list": "user_guide/messages/messages_overview.html", |
https://pylint--6628.org.readthedocs.build/en/6628/messages/messages_introduction
Doesn't work 😢
Let's handle all the messages/* redirects in RTD. I'll fix them after this gets merged!
There was a problem hiding this comment.
Ha right, RTD seems to preempt the single file redirect. Let me add a comment.
There was a problem hiding this comment.
Doesn't it mean we should do
"user_guide/messages/messages_introduction": "user_guide/messages/index.html",
"user_guide/messages/messages_list": "user_guide/messages/messages_overview.html",
?
There was a problem hiding this comment.
Lol, yeah that's probably it. Because the above link still doesn't work.
There was a problem hiding this comment.
Waiting for the pipeline to confirm it works but I think it make more sense to keep RTD for full dir redirect and our conf for single link redirect even if it means having two redirections instead of one.
There was a problem hiding this comment.
Hmm no, not working, even when clearing the redirect cache. Should I revert the latest commit ?
There was a problem hiding this comment.
The link we used to test is wrong I think. https://pylint--6628.org.readthedocs.build/en/6628/messages/messages_introduction should be https://pylint--6628.org.readthedocs.build/en/6628/messages/messages_introduction.html
Pierre-Sassoulas
force-pushed
the
cleanup-messages-doc
branch
from
350bf76 to
7354ca0
Compare
Pierre-Sassoulas
force-pushed
the
cleanup-messages-doc
branch
from
752d77c to
7354ca0
Compare
See discussion: #6628 (comment) Co-authored-by: Daniël van Noord <[email protected]>
|
The redirects for messages seem to work. However: https://pylint.pycqa.org/en/latest/messages/message_control.html does. |
|
@Pierre-Sassoulas Will you also fix the other two missing redirects in a follow-up? |
|
I tried, I don't understand why it's not working anymore (I tested in the middle of the MR and did not check again) I'm wondering if we should do everything in RTD interface ? I'm under the impression that they could interfere with each other. Another solution is to just let the 404 be, we're investing a colossal amount of time in this, if the doc is good and searchable the problem of 404 will not be a real one. |
Type of Changes
Description
Move the messages documentation to user guide and do the proper redirection.
Small reviewable part of #6589 and follow-up to #6613 and #6622