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 the issue in the Contribution References Documentation #2370

Merged
merged 3 commits into from
Aug 22, 2024

Conversation

varuntotakura
Copy link
Contributor

@varuntotakura varuntotakura commented Aug 20, 2024

Description

In the documentation Contributions page, when I tried to open the pull request hyperlink in the "Write documentation" and "Make changes in the code" sections, it is redirecting to https://www.pymc.io/projects/docs/en/stable/contributing/pr_tutorial.html#pr-tutorial page, but in actual it should redirect to https://python.arviz.org/en/latest/contributing/pr_tutorial.html#pr-tutorial

Link to issue: Issue in the documentation

Checklist

  • Follows official PR format
  • New features are properly documented
  • Changes are listed in changelog

📚 Documentation preview 📚: https://arviz--2370.org.readthedocs.build/en/2370/

Copy link

codecov bot commented Aug 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.01%. Comparing base (e6b5e2b) to head (aad274f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2370   +/-   ##
=======================================
  Coverage   87.01%   87.01%           
=======================================
  Files         124      124           
  Lines       12788    12788           
=======================================
  Hits        11128    11128           
  Misses       1660     1660           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@OriolAbril OriolAbril left a comment

Choose a reason for hiding this comment

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

Thanks for catching the wrong link! It was an unwanted side effect of intersphinx looking at all the documentation sites available via intersphinx_mapping. As the requested target didn't exist in the ArviZ docs but it did in the PyMC ones, it ended up linking to the pymc docs.

However, we don't want to stop using cross references, to fix the issue we need to fix that particular references using the non-existent pr_tutorial target. The reason for that is that if we used urls instead of cross references we would not be able to have multi-versioned docs, every time a link that should be internal is clicked we'd always end up in latest version. But if we are browsing the docs for version 0.17 and we click on internal links we want to get to the linked page, but still for the same version we were browsing.

The ideal fix for the issue would be to add (pr_tutorial)= right above https://github.com/arviz-devs/arviz/blob/main/doc/source/contributing/pr_tutorial.md?plain=1#L1 so the pr_tutorial target exists within our own docs and the cross reference gets resolved as a link to this page.

@varuntotakura
Copy link
Contributor Author

@OriolAbril I have made the modifications as suggested. Please check it and let me know if any more changes are needed

Copy link
Member

@OriolAbril OriolAbril left a comment

Choose a reason for hiding this comment

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

Thanks!

@OriolAbril OriolAbril changed the title Fix the issue in the Contribution References Documentation #2369 Fix the issue in the Contribution References Documentation Aug 22, 2024
@OriolAbril OriolAbril merged commit 8795992 into arviz-devs:main Aug 22, 2024
12 checks passed
@varuntotakura varuntotakura deleted the newfeatures branch August 28, 2024 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Issue in the documentation (https://python.arviz.org/en/latest/contributing/index.html)
2 participants