Skip to content

🧪 Fix tests for latest sphinx #993

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
chrisjsewell merged 1 commit into from
Oct 27, 2024
Merged

🧪 Fix tests for latest sphinx #993

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions tests/test_sphinx/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,10 @@ def read(
# pygments 2.11.0 introduces a whitespace tag
for pygment_whitespace in doc_div.select("pre > span.w"):
pygment_whitespace.replace_with(pygment_whitespace.text)
# something changed in sphinx 8 (or new docutils) to introduce this, although I couldn't find the actual commit,
# but in any case, it's not important for the regression test
for clearer_div in doc_div.findAll("div", {"class": "clearer"}):
clearer_div.decompose()
text = doc_div.prettify()
# changed in sphinx 7.2
text = text.replace('"Link to this', '"Permalink to this')
Expand Down
2 changes: 2 additions & 0 deletions tests/test_sphinx/test_sphinx_builds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,8 @@ def test_references_singlehtml(
# changed in sphinx 7.3
'="#document-index': '="index.html#document-index',
'="#document-other': '="index.html#document-other',
# change in sphinx 8
'href="index.html#': 'href="#',
},
)

Expand Down
16 changes: 8 additions & 8 deletions tests/test_sphinx/test_sphinx_builds/test_references_singlehtml.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,28 +29,28 @@ <h3>
</a>
</h3>
<p>
<a class="reference internal" href="index.html#document-other/other2">
<a class="reference internal" href="#document-other/other2">
<span class="doc">
Other 2 Title
</span>
</a>
</p>
<p>
<a class="reference internal" href="index.html#document-other/other2">
<a class="reference internal" href="#document-other/other2">
<span class="doc">
Other 2 Title
</span>
</a>
</p>
<p>
<a class="reference internal" href="index.html#document-other/other2">
<a class="reference internal" href="#document-other/other2">
<span class="std std-doc">
Other 2 Title
</span>
</a>
</p>
<p>
<a class="reference internal" href="index.html#title">
<a class="reference internal" href="#title">
<span class="std std-ref">
Title
</span>
Expand All @@ -71,21 +71,21 @@ <h3>
</section>
</div>
<p>
<a class="reference internal" href="index.html#document-other/other">
<a class="reference internal" href="#document-other/other">
<span class="doc">
Other Title
</span>
</a>
</p>
<p>
<a class="reference internal" href="index.html#document-other/other">
<a class="reference internal" href="#document-other/other">
<span class="doc">
Other Title
</span>
</a>
</p>
<p>
<a class="reference internal" href="index.html#document-other/other">
<a class="reference internal" href="#document-other/other">
<span class="std std-doc">
Other Title
</span>
Expand All @@ -99,7 +99,7 @@ <h3>
</a>
</p>
<p>
<a class="reference internal" href="index.html#other-title">
<a class="reference internal" href="#other-title">
<span class="std std-ref">
Other Title
</span>
Expand Down