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 pathlib
import shutil
import jupytext
def process():
"""Convert C++ demos in the Jupytext 'light' format into MyST
flavoured markdown (and ipynb?) using Jupytext. These files can then be
included in Sphinx documentation.
"""
# Make demo doc directory
demo_doc_dir = pathlib.Path("./demos")
demo_doc_dir.mkdir(parents=True, exist_ok=True)
# Directories to scan demo code files
demo_dirs = pathlib.Path("../../demo")
# Iterate over subdirectories containing demos
for demo_subdir in demo_dirs.iterdir():
if demo_subdir.is_dir():
fname = pathlib.Path("/demo_" + demo_subdir.name)
demo_doc_subdir = demo_doc_dir / fname.name
demo_doc_subdir.mkdir(parents=True, exist_ok=True)
# Process each demo using jupytext/myst
for demo_file in demo_subdir.glob("main.cpp"):
# Copy demo files into documentation demo directory
shutil.copy(demo_file, demo_doc_subdir)
cpp_demo = jupytext.read(demo_file)
cpp_myst_text = jupytext.writes(cpp_demo, fmt="myst")
# myst-parser does not process blocks with {code-cell}
cpp_myst_text = cpp_myst_text.replace("{code-cell}", "cpp")
# Similarly for python file, dump python myst text in cpp myst
for pydemo_file in demo_subdir.glob("*.py"):
shutil.copy(pydemo_file, demo_doc_subdir)
python_demo = jupytext.read(pydemo_file)
python_myst_text = jupytext.writes(python_demo, fmt="myst")
python_myst_text = python_myst_text.replace("{code-cell}", "python")
cpp_myst_text = cpp_myst_text.replace("![ufl-code]", python_myst_text)
for cmake_file in demo_subdir.glob("CMakeLists.txt"):
shutil.copy(cmake_file, demo_doc_subdir)
myst_file = (demo_doc_dir / fname.name).with_suffix(".md")
with open(myst_file, "w") as fw:
fw.write(cpp_myst_text)
# There is a possibility to use jupyter-notebooks with C++/C kernels
# ipynb_file = (demo_doc_dir / fname.name).with_suffix(".ipynb")
# jupytext.write(cpp_demo, ipynb_file, fmt="ipynb")
if __name__ == "__main__":
process()
|
