Skip to content
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

Fix RTD links to additional tools in the README #10079

Merged
merged 3 commits into from
Nov 12, 2024

Conversation

bnjmnp
Copy link
Contributor

@bnjmnp bnjmnp commented Nov 12, 2024

Type of Changes

Type
πŸ› Bug fix
✨ New feature
πŸ”¨ Refactoring
βœ“ πŸ“œ Docs

Description

Just a quick fix of the README

DanielNoord
DanielNoord previously approved these changes Nov 12, 2024
@DanielNoord DanielNoord added Documentation πŸ“— Skip news πŸ”‡ This change does not require a changelog entry labels Nov 12, 2024
@Pierre-Sassoulas
Copy link
Member

Thank you for catching this and fixing it @bnjmnp. Do you mind adding a redirect here too please ?

pylint/doc/conf.py

Lines 60 to 98 in 614f80e

redirects: dict[str, str] = {
# "<source>": "<target>"
"additional_commands/index": "../index.html",
"development_guide/index": "api/index.html",
"development_guide/contribute": "../development_guide/contributor_guide/index.html",
"development_guide/contributor_guide": "contributor_guide/index.html",
"development_guide/profiling": "../development_guide/contributor_guide/profiling.html",
"development_guide/tests/index": "../contributor_guide/tests/index.html",
"development_guide/tests/install": "../contributor_guide/tests/install.html",
"development_guide/tests/launching_test": "../contributor_guide/tests/launching_test.html",
# There was a typo in the original file, don't fix.
"development_guide/tests/writting_test": "../contributor_guide/tests/writing_test.html",
"development/testing": "tests/index.html",
"how_tos/custom_checkers": "../development_guide/how_tos/custom_checkers.html",
"how_tos/index": "../development_guide/how_tos/index.html",
"how_tos/plugins": "../development_guide/how_tos/plugins.html",
"how_tos/transform_plugins": "../development_guide/how_tos/transform_plugins.html",
"intro": "index.html",
"messages/messages_introduction": "../user_guide/messages/index.html",
"messages/messages_list": "../user_guide/messages/messages_overview.html",
"support": "contact.html",
"technical_reference/c_extensions": "../user_guide/messages/error/no-member.html",
"technical_reference/extensions": "../user_guide/checkers/extensions.html",
"technical_reference/checkers": "../development_guide/technical_reference/checkers.html",
"technical_reference/features": "../user_guide/checkers/features.html",
"technical_reference/index": "../development_guide/technical_reference/index.html",
"technical_reference/startup": "../development_guide/technical_reference/startup.html",
"user_guide/configuration/naming-styles": "../user_guide/messages/convention/invalid-name.html",
"user_guide/ide_integration/flymake-emacs": "../installation/ide_integration/flymake-emacs.html",
"user_guide/ide_integration/ide-integration": "../installation/ide_integration/index.html",
"user_guide/ide-integration": "installation.html",
"user_guide/ide_integration/textmate": "../installation/ide_integration/textmate.html",
"user_guide/index": "installation/index.html",
"user_guide/message-control": "messages/message_control.html",
"user_guide/options": "configuration/all-options.html",
"user_guide/output": "usage/output.html",
"user_guide/pre-commit-integration": "installation/pre-commit-integration.html",
"user_guide/run": "usage/run.html",
}

Copy link

codecov bot commented Nov 12, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 95.80%. Comparing base (614f80e) to head (f674ef4).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #10079   +/-   ##
=======================================
  Coverage   95.80%   95.80%           
=======================================
  Files         174      174           
  Lines       18962    18962           
=======================================
  Hits        18166    18166           
  Misses        796      796           

@bnjmnp
Copy link
Contributor Author

bnjmnp commented Nov 12, 2024

I don't fully understand the redirects dict. I assume in this case it would be this:

    "pyreverse": "../additional_tools/pyreverse/index.html",
    "symilar": "../additional_tools/symilar/index.html",

@Pierre-Sassoulas
Copy link
Member

Yeam seems sensible. It's possible to test on the readthedoc instance generated from the PR : for example : https://pylint--10079.org.readthedocs.build/en/10079/how_tos/index.html redirect as expected).

In this case:
https://pylint--10079.org.readthedocs.build/en/10079/pyreverse.html
https://pylint--10079.org.readthedocs.build/en/10079/symilar.html
Should work.

@bnjmnp
Copy link
Contributor Author

bnjmnp commented Nov 12, 2024

No luck with my new commit, the links still don't work.
Maybe ../ needs to be removed for the target URLs?

doc/conf.py Outdated Show resolved Hide resolved
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @bnjmnp !

@Pierre-Sassoulas Pierre-Sassoulas enabled auto-merge (squash) November 12, 2024 19:41
@bnjmnp
Copy link
Contributor Author

bnjmnp commented Nov 12, 2024

It was my pleasure.
Thank you for your work on pylint.

@Pierre-Sassoulas Pierre-Sassoulas merged commit 9b272cc into pylint-dev:main Nov 12, 2024
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation πŸ“— Skip news πŸ”‡ This change does not require a changelog entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants