Skip to content

Commit a017108

Browse files
resolve conversation
1 parent 44cc980 commit a017108

File tree

3 files changed

+13
-19
lines changed

3 files changed

+13
-19
lines changed

doc/changes/unreleased.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This version of the PTB adds nox tasks to check links present in our documentati
1111
`docs:links:check` is run in the CI `checks.yml`. If this step fails in the CI,
1212
please check the output & manually resolve the issues. There might be some cases
1313
where you need to update your doc/conf.py with specific values for the allowed
14-
options for the Linkcheck Builder.
14+
options for the [Linkcheck Builder](https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder).
1515

1616
We recommend the following values be added:
1717

doc/developer_guide/modules/sphinx/sphinx.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sphinx
44
sphinx-multiversion
55
+++++++++++++++++++
66

7-
The `sphinx-multiversion` extension is a modified copy of `Holzhaus/sphinx-multiversion <https://github.com/sphinx-contrib/multiversion>`_. This copy was taken from version :code:`0.24.0`.
7+
The `sphinx-multiversion` extension is a modified copy of `sphinx-contrib/multiversion <https://github.com/sphinx-contrib/multiversion>`_. This copy was taken from version :code:`0.24.0`.
88

99
It has been adjusted with minor code changes and modified defaults to work seamlessly with Exasol integration projects, which often require a specific project structure and layout. Additionally, it is designed to be used with an HTML theme that supports displaying and selecting multiple versions if the `versions` variable is set in the HTML context of sphinx. As of this writing, the theme used in conjunction with this modified version of `sphinx-multiversion` is `SHIBUYA <https://github.com/lepture/shibuya>`_, version :code:`2024.10.15`.
1010

test/unit/documentation_test.py

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ def file1():
2424
@pytest.fixture()
2525
def index():
2626
return """.. _Test:
27+
2728
Test
2829
____
2930
@@ -61,33 +62,26 @@ def test_docs_links(index, file1, expected1, tmp_path):
6162
@pytest.mark.parametrize(
6263
"file2, expected2",
6364
[
64-
("https://httpbin.org/status/200", (0, "")),
65+
("https://github.com/exasol/python-toolbox", (0, "")),
6566
(
66-
"https://httpbin.org/status/301",
67+
"http://nox.thea.codes/en/stable/",
6768
(
6869
0,
69-
"file.rst:1: [redirected with Found] https://httpbin.org/status/301 to https://httpbin.org/get\n",
70+
"file.rst:1: [redirected with Found] http://nox.thea.codes/en/stable/ to https://nox.thea.codes/en/stable/\n",
7071
),
7172
),
7273
(
73-
"https://httpbin.org/status/302",
74-
(
75-
0,
76-
"file.rst:1: [redirected with Found] https://httpbin.org/status/302 to https://httpbin.org/get\n",
77-
),
78-
),
79-
(
80-
"https://httpbin.org/status/303",
81-
(
82-
0,
83-
"file.rst:1: [redirected with Found] https://httpbin.org/status/303 to https://httpbin.org/get\n",
84-
),
74+
"https://github.com/exasol/python-toolbox/pull",
75+
(
76+
0,
77+
"file.rst:1: [redirected permanently] https://github.com/exasol/python-toolbox/pull to https://github.com/exasol/python-toolbox/pulls\n",
78+
),
8579
),
8680
(
87-
"https://httpbin.org/status/404",
81+
"https://github.com/exasol/python-toolbox/asdf",
8882
(
8983
1,
90-
"file.rst:1: [broken] https://httpbin.org/status/404: 404 Client Error: NOT FOUND for url: https://httpbin.org/status/404\n",
84+
"file.rst:1: [broken] https://github.com/exasol/python-toolbox/asdf: 404 Client Error: Not Found for url: https://github.com/exasol/python-toolbox/asdf\n",
9185
),
9286
),
9387
],

0 commit comments

Comments
 (0)