1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
"""Script run to update the kitchen sink from https://sphinx-themes.org."""
from pathlib import Path
from urllib.request import urlopen
EXTRA_MESSAGE = """\
.. note::
The Kitchen Sink was generated from the
`Sphinx Themes website <https://sphinx-themes.org/>`_, a community-supported showcase
of themes for `Sphinx <https://www.sphinx-doc.org/>`_.
Check it out to see other great themes.
.. button-link:: https://sphinx-themes.org
:color: primary
Go to Sphinx Themes
"""
kitchen_sink_files = [
"admonitions.rst",
"api.rst",
"blocks.rst",
"generic.rst",
"images.rst",
"index.rst",
"lists.rst",
"really-long.rst",
"structure.rst",
"tables.rst",
"typography.rst",
]
path_sink = Path(__file__).parent.parent / "examples" / "kitchen-sink"
for ifile in kitchen_sink_files:
print(f"Reading {ifile}...")
url = f"https://github.com/sphinx-themes/sphinx-themes.org/raw/master/sample-docs/kitchen-sink/{ifile}"
text = urlopen(url).read().decode()
# The sphinx-themes docs expect Furo to be installed, so we overwrite w/ PST
text = text.replace("src/furo", "src/pydata_sphinx_theme")
text = text.replace(":any:`sphinx.ext.autodoc`", "``sphinx.ext.autodoc``")
# Add introductory message directing people to Sphinx Themes
if "index" in ifile:
text = text.replace("============", "============\n\n" + EXTRA_MESSAGE)
(path_sink / f"{ifile}").write_text(text)
print(f"Finished updating {len(kitchen_sink_files)} files...")
|
