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

Restore 'noindex' support for JS, Python domains #12844

Merged
merged 4 commits into from
Sep 18, 2024

Conversation

stephenfin
Copy link
Contributor

@stephenfin stephenfin commented Aug 29, 2024

Feature or Bugfix

  • Bugfix

Purpose

Fixes: e439c6f (Ensure that old-style object description options are respected (#12620))
Closes: #12843

Detail

Note
Ideally this should be backport to the 7.x branch, but it appears we don't maintain stable branches any more?

Relates

None.

Signed-off-by: Stephen Finucane <[email protected]>
Fixes: e439c6f (Ensure that old-style object description options are respected (sphinx-doc#12620))
Closes: sphinx-doc#12843
@picnixz
Copy link
Member

picnixz commented Aug 30, 2024

Ideally this should be backport to the 7.x branch, but it appears we don't maintain stable branches any more?

Nope, we don't have backports (too much work and not enough hands...)

Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

Are these the only parts in the code base that require this? and could you perhaps add a test for that?

@stephenfin
Copy link
Contributor Author

stephenfin commented Aug 30, 2024

Are these the only parts in the code base that require this? and could you perhaps add a test for that?

I could, but I'm away for the next week and a bit so I'll be a while. I also don't know if it's essential given this is effectively continuing what was done in e439c6f through to completion and that didn't have tests. In addition, this is for a feature that will be deprecated soon and I have a reproducer linked in the bug that proves this fixes the issue, albeit manually. So maybe we can skirt around without one here and just get this in?

Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

I'll try and add a test later today, but I'm on a flight at some point so may not be that productive.

A

@stephenfin stephenfin changed the title Restore 'no-index' support for JS, Python domains Restore 'noindex' support for JS, Python domains Aug 31, 2024
@AA-Turner AA-Turner merged commit bce70da into sphinx-doc:master Sep 18, 2024
22 checks passed
@stephenfin stephenfin deleted the issue-12843 branch September 18, 2024 09:15
@stephenfin
Copy link
Contributor Author

Thanks 🙏

@AA-Turner AA-Turner added this to the 8.1.x milestone Oct 6, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

no-index ignored for :py:module:
4 participants