-
Notifications
You must be signed in to change notification settings - Fork 67
Expand file tree
/
Copy pathconf.py
More file actions
135 lines (112 loc) · 4.14 KB
/
conf.py
File metadata and controls
135 lines (112 loc) · 4.14 KB
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "NGFF"
copyright = "2020-2025, NGFF Community"
author = "NGFF Community"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"myst_parser",
"sphinx_reredirects",
"sphinx_design",
"sphinxcontrib.bibtex"]
bibtex_bibfiles = ["references.bib"]
source_suffix = [".rst", ".md"]
myst_heading_anchors = 5
myst_enable_extensions = [
"deflist",
"strikethrough",
"colon_fence"
]
templates_path = ["_templates"]
exclude_patterns = [
"_build",
"Thumbs.db",
".DS_Store",
".git",
".pytest_cache",
"**/.pytest_cache",
"**/.tox",
"README.md",
"LICENSE.md",
"CONTRIBUTING.md",
"**/README.md",
"**/LICENSE.md",
"**/CONTRIBUTING.md",
]
redirects = {
"tools/index": "../resources/tools/index.html",
"publications/index": "../resources/publications/index.html",
"data/index": "../resources/data/index.html",
"about/index": "../index.html",
"0.1/": "../specifications/0.1/index.html",
"0.2/": "../specifications/0.2/index.html",
"0.3/": "../specifications/0.3/index.html",
"0.4/": "../specifications/0.4/index.html",
"0.5/": "../specifications/0.5/index.html",
"latest/index": "../specifications/0.5/index.html",
"latest/": "../specifications/0.5/index.html",
"dev/index": "../specifications/dev/index.html",
"dev/": "../specifications/dev/index.html"
}
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "pydata_sphinx_theme"
html_theme_options = {
"header_links_before_dropdown": 6,
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/ome/ngff",
"icon": "fab fa-github",
"type": "fontawesome",
},
],
"use_download_button": True,
}
html_static_path = ["_static"]
html_css_files = [
"https://cdn.datatables.net/v/dt/dt-1.11.5/datatables.min.css",
]
html_js_files = [
"https://cdn.datatables.net/v/dt/dt-1.11.5/datatables.min.js",
"main.js",
]
html_extra_path = [
"_html_extra",
]
def build_served_html():
import glob
import subprocess
import sys
import os
import shutil
from pathlib import Path
os.chdir(Path(__file__).parent)
versions = [d for d in os.listdir("specifications") if os.path.isdir(os.path.join("specifications", d))]
for version in versions:
# copy schemas to _html_extra
os.makedirs(f'_html_extra/{version}/schemas', exist_ok=True)
schemas = glob.glob(f'specifications/{version}/**/*.schema', recursive=True)
for schema in schemas:
shutil.copy2(schema, f'_html_extra/{version}/schemas/')
print(f'✅ Copied schemas for version {version}')
# find 'pre_build.py' in 'specifications' subdirectories
script = glob.glob(f'specifications/{version}/**/pre_build.py', recursive=True)[0]
subprocess.check_call([sys.executable, script])
print('✅ Built rendered examples/schemas for version', version)
# build jupyter-book docs in specification submodules
myst_file = glob.glob(f'specifications/{version}/**/myst.yml', recursive=True)[0]
bikeshed_output = f'specifications/{version}/index.html'
# copy built html files to _html_extra
try:
if os.path.exists(bikeshed_output):
shutil.copy2(bikeshed_output, f'_html_extra/{version}/index.html')
print(f'✅ Found legacy bikeshed, serving as extra html for {version}')
except Exception as e:
print(f'⚠️ Could not copy served html for version {version}: {e}')
build_served_html()