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
|
# Copyright (C) 2017-2023 Garth N. Wells, Jack S. Hale
#
# This file is part of DOLFINx (https://www.fenicsproject.org)
#
# SPDX-License-Identifier: LGPL-3.0-or-later
import os
import pathlib
import runpy
import shutil
import jupytext
def process():
"""Convert Python demos in the Jupytext 'light' format into MyST
flavoured markdown and ipynb using Jupytext. These files can then be
included in Sphinx documentation.
"""
# Directories to scan
subdirs = [pathlib.Path("../../demo")]
# Iterate over subdirectories containing demos
for subdir in subdirs:
# Make demo doc directory
demo_dir = pathlib.Path("./demos")
demo_dir.mkdir(parents=True, exist_ok=True)
# Process each demo using jupytext/myst
for demo in subdir.glob("**/demo*.py"):
python_demo = jupytext.read(demo)
myst_text = jupytext.writes(python_demo, fmt="myst")
# myst-parser does not process blocks with {code-cell}
myst_text = myst_text.replace("{code-cell}", "python")
myst_file = (demo_dir / demo.name).with_suffix(".md")
with open(myst_file, "w") as fw:
fw.write(myst_text)
ipynb_file = (demo_dir / demo.name).with_suffix(".ipynb")
jupytext.write(python_demo, ipynb_file, fmt="ipynb")
# Copy python demo files into documentation demo directory
shutil.copy(demo, demo_dir)
# If demo saves matplotlib images, run the demo to create
# images
code = demo.read_text()
if "savefig" in code:
demo = demo.resolve()
here = os.getcwd()
os.chdir(demo_dir)
runpy.run_path(str(demo))
os.chdir(here)
# Copy images used in demos
for file in subdir.glob("**/*.png"):
shutil.copy(file, demo_dir)
if __name__ == "__main__":
process()
|
