Skip to content

Commit 05b9bc7

Browse files
authored
Some linkcheck updates (#2275)
Ignore Sass urls, Do not allow http:, only https: even in examples. removed unused URLs don't link to http://python.py
1 parent 6734aae commit 05b9bc7

File tree

5 files changed

+11
-12
lines changed

5 files changed

+11
-12
lines changed

docs/community/topics/i18n.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This section covers how to internationalize (I18n) and localize (L10n) the PyDat
55
For details on how to localize the configurable strings in your Sphinx project, see the
66
:ref:`User guide section on internationalization <user-guide-i18n>`.
77

8-
The PyData Sphinx Theme I18n/i10n workflows are based on `GNU Gettext <http://www.gnu.org/software/gettext/>`__
8+
The PyData Sphinx Theme I18n/i10n workflows are based on `GNU Gettext <https://www.gnu.org/software/gettext/>`__
99
and `pybabel <https://babel.pocoo.org/en/latest/messages.html>`__ is used to keep the catalogs up to date.
1010
Crowd-sourced localizations are managed on `Transifex <https://explore.transifex.com/12rambau/pydata-sphinx-theme/>`__.
1111

docs/conf.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -372,15 +372,15 @@ def setup(app: Sphinx) -> Dict[str, Any]:
372372
r"https://github.com.+?#.*",
373373
r"https://www.sphinx-doc.org/en/master/*/.+?#.+?",
374374
# sample urls
375-
"http://someurl/release-0.1.0.tar-gz",
376-
"http://python.py",
375+
"https://someurl/release-0.1.0.tar-gz",
377376
# for whatever reason the Ablog index is treated as broken
378377
"../examples/blog/index.html",
379378
# get a 403 on CI
380379
"https://canvas.workday.com/styles/tokens/type",
381380
"https://unsplash.com/",
382381
r"https?://www.gnu.org/software/gettext/.*",
383382
r"https://www.npmjs.com/.*",
383+
r"https://sass-lang.com/.*",
384384
]
385385

386386
linkcheck_allowed_redirects = {
@@ -400,7 +400,6 @@ def setup(app: Sphinx) -> Dict[str, Any]:
400400
r"https://www.sphinx-doc.org/": "https://www.sphinx-doc.org/en/master/",
401401
r"https://idtracker.ai/": "https://idtracker.ai/latest/",
402402
r"https://gitlab.com": "https://about.gitlab.com/",
403-
r"http://www.yahoo.com": "https://www.yahoo.com/",
404403
r"https://feature-engine.readthedocs.io/": "https://feature-engine.trainindata.com/en/latest/",
405404
r"https://picsum.photos/": r"https://fastly.picsum.photos/",
406405
}

docs/examples/kitchen-sink/blocks.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ https://docutils.sourceforge.io/docs/ref/rst/directives.html#parsed-literal-bloc
169169
.. parsed-literal::
170170
171171
# parsed-literal test
172-
curl -O http://someurl/release-0.1.0.tar-gz
172+
curl -O https://someurl/release-0.1.0.tar-gz
173173
echo "This is an intentionally very long line because I want to make sure that we are handling scrollable code blocks correctly."
174174
175175
Code Block

docs/user_guide/theme-elements.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,15 @@ For example, the following code:
6060
`````{tab-item} rST
6161
````rst
6262
.. code-block:: python
63-
:caption: python.py
63+
:caption: `python.py`
6464
6565
print("A code block with a caption.")
6666
````
6767
`````
6868
`````{tab-item} Markdown
6969
````md
7070
```{code-block} python
71-
:caption: python.py
71+
:caption: `python.py`
7272
7373
print("A code block with a caption.")
7474
```
@@ -79,7 +79,7 @@ print("A code block with a caption.")
7979
results in:
8080

8181
```{code-block} python
82-
:caption: python.py
82+
:caption: `python.py`
8383
8484
print("A code block with a caption.")
8585
```
@@ -91,7 +91,7 @@ For example, the following code:
9191
`````{tab-item} rST
9292
````rst
9393
.. code-block:: python
94-
:caption: python.py
94+
:caption: `python.py`
9595
:linenos:
9696
9797
print("A code block with a caption and line numbers.")
@@ -102,7 +102,7 @@ For example, the following code:
102102
`````{tab-item} Markdown
103103
````md
104104
```{code-block} python
105-
:caption: python.py
105+
:caption: `python.py`
106106
:linenos:
107107
108108
print("A code block with a caption and line numbers.")
@@ -116,7 +116,7 @@ print("A code block with a caption and line numbers.")
116116
results in:
117117

118118
```{code-block} python
119-
:caption: python.py
119+
:caption: `python.py`
120120
:linenos:
121121
122122
print("A code block with a caption and line numbers.")

tests/sites/version_switcher/fixture_blocks.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ https://docutils.sourceforge.io/docs/ref/rst/directives.html#parsed-literal-bloc
174174
.. parsed-literal::
175175
176176
# parsed-literal test
177-
curl -O http://someurl/release-0.1.0.tar-gz
177+
curl -O https://someurl/release-0.1.0.tar-gz
178178
echo "This is an intentionally very long line because I want to make sure that we are handling scrollable code blocks correctly."
179179
180180
Code Block

0 commit comments

Comments
 (0)