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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
#
# openslide-python - Python bindings for the OpenSlide library
#
# Copyright (c) 2014 Carnegie Mellon University
# Copyright (c) 2024 Benjamin Gilbert
#
# This library is free software; you can redistribute it and/or modify it
# under the terms of version 2.1 of the GNU Lesser General Public License
# as published by the Free Software Foundation.
#
# This library is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
# License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Sphinx hardcodes that certain output paths have names starting with
# an underscore.
# Jekyll hardcodes that filenames starting with an underscore are not
# deployed to the website.
# Rename Sphinx output paths to drop the underscore.
from __future__ import annotations
import os
from pathlib import Path
from sphinx.application import Sphinx
from sphinx.util import logging
from sphinx.util.console import bold
DIRS = {
'_static': 'static',
'_sources': 'sources',
}
FILES = {
# Added in Sphinx 5.0.0, scheduled to be removed in Sphinx 6
'static/_sphinx_javascript_frameworks_compat.js': 'static/sphinx_javascript_frameworks_compat.js', # noqa: E501
}
REWRITE_EXTENSIONS = {'.html', '.js'}
def remove_path_underscores(app: Sphinx, exception: Exception | None) -> None:
if exception:
return
# Get logger
logger = logging.getLogger(__name__)
logger.info(bold('fixing pathnames... '), nonl=True)
# Rewrite references in HTML/JS files
outdir = Path(app.outdir)
for dirpath, _, filenames in os.walk(outdir):
for filename in filenames:
path = Path(dirpath) / filename
if path.suffix in REWRITE_EXTENSIONS:
with path.open(encoding='utf-8') as fh:
contents = fh.read()
for old, new in DIRS.items():
contents = contents.replace(old + '/', new + '/')
for old, new in FILES.items():
contents = contents.replace(old, new)
with path.open('w', encoding='utf-8') as fh:
fh.write(contents)
# Move directory contents
for old, new in DIRS.items():
olddir = outdir / old
newdir = outdir / new
newdir.mkdir(exist_ok=True)
if olddir.is_dir():
for oldfile in olddir.iterdir():
oldfile.rename(newdir / oldfile.name)
olddir.rmdir()
# Move files
for old, new in FILES.items():
oldfile = outdir / old
if oldfile.is_file():
oldfile.rename(outdir / new)
logger.info('done')
def setup(app: Sphinx) -> None:
app.connect('build-finished', remove_path_underscores)
|
