Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[BUG] Fix redirect-from Sphinx extension #27915

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.

Sign up for GitHub

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

Merged
merged 14 commits into from
Mar 20, 2024
Merged

[BUG] Fix redirect-from Sphinx extension #27915

Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
0361c07
[BUG] Fix clear_doc for redirect-from domain
trananso Mar 13, 2024
21af6df
[BUG] Implement merge_domaindata
trananso Mar 13, 2024
aedac13
[BUG] Remove check for redirects that already exist
trananso Mar 13, 2024
2e95ca8
[LINT] Fix linting issue
trananso Mar 13, 2024
ca80d0e
[ENH] Switch Directive to SphinxDirective, which has self.env
trananso Mar 14, 2024
c1343ad
[BUG] Re-introduce sanity check
trananso Mar 14, 2024
548bd15
Merge branch 'matplotlib:main' into fix-sphinx-redirect-from-directives
trananso Mar 14, 2024
45b37ce
Merge branch 'fix-sphinx-redirect-from-directives' of https://github.…
trananso Mar 14, 2024
c5269a5
[BUG] Reintroduce merge_domaindata sanity check
trananso Mar 14, 2024
a67e1d2
Refactor
trananso Mar 14, 2024
f9162c2
Merge branch 'matplotlib:main' into fix-sphinx-redirect-from-directives
trananso Mar 15, 2024
ab4b181
Merge remote-tracking branch 'upstream/main' into fix-sphinx-redirect…
trananso Mar 18, 2024
aa8cb4a
Revert changes to merge_domaindata
trananso Mar 18, 2024
cd4b407
Cleanup code
trananso Mar 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions doc/sphinxext/redirect_from.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"""

from pathlib import Path
from docutils.parsers.rst import Directive
from sphinx.util.docutils import SphinxDirective
from sphinx.domains import Domain
from sphinx.util import logging

Expand All @@ -51,9 +51,9 @@


def setup(app):
RedirectFrom.app = app
app.add_directive("redirect-from", RedirectFrom)
app.add_domain(RedirectFromDomain)
app.connect("builder-inited", _clear_redirects)
app.connect("build-finished", _generate_redirects)

metadata = {'parallel_read_safe': True}
Expand All @@ -73,8 +73,8 @@ def redirects(self):
"""The mapping of the redirects."""
return self.data.setdefault('redirects', {})

def clear_doc(self, docnames):
self.redirects.clear()
def clear_doc(self, docname):
self.redirects.pop(docname, None)

def merge_domaindata(self, docnames, otherdata):
for src, dst in otherdata['redirects'].items():
Expand All @@ -86,15 +86,14 @@ def merge_domaindata(self, docnames, otherdata):
f"{self.redirects[src]} and {otherdata['redirects'][src]}")


class RedirectFrom(Directive):
class RedirectFrom(SphinxDirective):
required_arguments = 1

def run(self):
redirected_doc, = self.arguments
env = self.app.env
domain = env.get_domain('redirect_from')
current_doc = env.path2doc(self.state.document.current_source)
redirected_reldoc, _ = env.relfn2path(redirected_doc, current_doc)
domain = self.env.get_domain('redirect_from')
current_doc = self.env.path2doc(self.state.document.current_source)
redirected_reldoc, _ = self.env.relfn2path(redirected_doc, current_doc)
if redirected_reldoc in domain.redirects:
raise ValueError(
f"{redirected_reldoc} is already noted as redirecting to "
Expand All @@ -119,3 +118,10 @@ def _generate_redirects(app, exception):
logger.info('making refresh html file: %s redirect to %s', k, v)
p.parent.mkdir(parents=True, exist_ok=True)
p.write_text(html, encoding='utf-8')


def _clear_redirects(app):
domain = app.env.get_domain('redirect_from')
if domain.redirects:
logger.info('clearing cached redirects')
domain.redirects.clear()