From 5856575ab07524846c466386a58ec55b23cd4838 Mon Sep 17 00:00:00 2001 From: M Bussonnier Date: Thu, 10 Oct 2024 09:52:34 +0200 Subject: [PATCH] Update some of the diverging links. Update the script with colors for better readability. It is weird but www.sphinx-doc.org redirecto to sphinx-doc.org/en/master, and display docs. But base sphinx-doc.org/ (without www) hangs for me. --- docs/community/structure.md | 2 +- docs/conf.py | 2 +- docs/examples/kitchen-sink/index.rst | 2 +- docs/scripts/update_kitchen_sink.py | 2 +- tools/divergent_links.py | 9 +++++---- 5 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/community/structure.md b/docs/community/structure.md index f16297169..69360a9d5 100644 --- a/docs/community/structure.md +++ b/docs/community/structure.md @@ -3,7 +3,7 @@ ## Location and structure of documentation The documentation for this theme is in the `docs/` folder. -It is structured as a [Sphinx documentation site](https://sphinx-doc.org). +It is structured as a [Sphinx documentation site](https://www.sphinx-doc.org/). The content is written in a combination of reStructuredText and MyST Markdown. ## Location and structure of CSS/JS assets diff --git a/docs/conf.py b/docs/conf.py index af71a33ec..de9295db7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -148,7 +148,7 @@ "external_links": [ { "url": "https://pydata.org", - "name": "PyData", + "name": "PyData Website", }, { "url": "https://numfocus.org/", diff --git a/docs/examples/kitchen-sink/index.rst b/docs/examples/kitchen-sink/index.rst index ab2b190a9..ea7f77a14 100644 --- a/docs/examples/kitchen-sink/index.rst +++ b/docs/examples/kitchen-sink/index.rst @@ -8,7 +8,7 @@ Kitchen Sink .. note:: - The Kitchen Sink was generated from the `Sphinx Themes website `_, a community-supported showcase of themes for `Sphinx `_. + The Kitchen Sink was generated from the `Sphinx Themes website `_, a community-supported showcase of themes for `Sphinx `_. Check it out to see other great themes. .. button-link:: https://sphinx-themes.org diff --git a/docs/scripts/update_kitchen_sink.py b/docs/scripts/update_kitchen_sink.py index 230f79fa9..4612e6687 100644 --- a/docs/scripts/update_kitchen_sink.py +++ b/docs/scripts/update_kitchen_sink.py @@ -6,7 +6,7 @@ EXTRA_MESSAGE = """\ .. note:: - The Kitchen Sink was generated from the `Sphinx Themes website `_, a community-supported showcase of themes for `Sphinx `_. + The Kitchen Sink was generated from the `Sphinx Themes website `_, a community-supported showcase of themes for `Sphinx `_. Check it out to see other great themes. .. button-link:: https://sphinx-themes.org diff --git a/tools/divergent_links.py b/tools/divergent_links.py index ed78d7892..fae9355e8 100644 --- a/tools/divergent_links.py +++ b/tools/divergent_links.py @@ -22,6 +22,7 @@ from urllib.parse import urljoin from bs4 import BeautifulSoup +from rich import print # when looking at inconsistent links across pages, # a number of text is recurrent and appear on many pages. @@ -90,16 +91,16 @@ def duplicates(self): uniq_url = {u for u, _ in url_pages} if len(uniq_url) >= 2: print( - f'The link text "{content!r}" appears {len(url_pages)} times, ' + f"The link text [red]{content!r}[/red] appears {len(url_pages)} times, " f"and links to {len(uniq_url)} different URLs, on the following pages:" ) dct = defaultdict(list) for u, p in url_pages: dct[u].append(p) for u, ps in dct.items(): - print(" ", u, "in") - for p in ps: - print(" ", p) + print(f" [blue]{u}[/blue] in") + for p in set(ps): + print(f" [green]{p}[/green]") if len(sys.argv) == 3 and sys.argv[2] == "--all":