19import lxml.etree
as ET
23from datetime
import date
25sys.path.insert(0, os.path.abspath(
"../Base/Python"))
26sys.path.insert(0, os.path.abspath(
"./_ext"))
40 "sphinx_markdown_tables",
53autodoc_mock_imports = [
59myst_enable_extensions = [
69myst_heading_anchors = 6
72myst_dmath_allow_labels =
True
77 Given a Slicer source director, extract <major>.<minor> version
78 from top-level `CMakeLists.txt`.
80 Return a dictionary containing `major` and `minor` version components as strings
82 slicer_src_dir = os.path.abspath(slicer_src_dir)
84 part: re.compile(rf
'set\(Slicer_VERSION_{part.upper()} "(\d+)"\)')
85 for part
in [
"major",
"minor"]
90 cmakelists_path = os.path.join(slicer_src_dir,
"CMakeLists.txt")
91 with open(cmakelists_path)
as cmake_file:
92 for line
in cmake_file:
93 for part, pattern
in version_patterns.items():
94 match = pattern.match(line.strip())
96 version_parts[part] = match.group(1)
97 if len(version_parts) == len(version_patterns ):
100 if len(version_parts) != len(version_patterns):
101 raise ValueError(f
"Failed to extract version from {cmakelists_path}")
108 Determine the Doxygen documentation version to use based on the Slicer version.
110 Return Doxygen version identifier (`v<major>.<minor>` for Stable, `main` for Preview)
113 slicer_repo_dir = os.path.dirname(os.path.dirname(__file__))
117 is_even = int(version_parts[
"minor"]) % 2 == 0
118 return "v{major}.{minor}".format(**version_parts)
if is_even
else "main"
123print(f
"Slicer API documentation URL scheme: {slicerapidocs_url_scheme}")
133 "slicerapidocs": slicerapidocs_url_scheme,
138templates_path = [
"_templates"]
143source_suffix = [
".rst",
".md"]
150copyright = f
"{date.today().year}, Slicer Community"
151author =
"Slicer Community"
165exclude_patterns = [
"_build",
"Thumbs.db",
".DS_Store",
"_moduledescriptions"]
169if os.environ.get(
"EXCLUDE_API_REFERENCE",
"False") ==
"True":
170 print(
"API reference is excluded from documentation.")
171 exclude_patterns.append(
"developer_guide/vtkTeem.rst")
172 exclude_patterns.append(
"developer_guide/vtkAddon.rst")
173 exclude_patterns.append(
"developer_guide/vtkITK.rst")
174 exclude_patterns.append(
"developer_guide/slicer.rst")
175 exclude_patterns.append(
"developer_guide/mrml.rst")
180 "title":
"Page Not Found",
182<h1>Page Not Found</h1>
183<p>Sorry, we couldn't find that page.</p>
184<p>Try using the search box or go to the homepage.</p>
189pygments_style =
"sphinx"
192todo_include_todos =
False
195rst_prolog = open(
"global.rst.in").read()
199html_logo =
"_static/images/3D-Slicer-Mark.png"
206html_theme =
"sphinx_rtd_theme"
212html_theme_options = {
214 "includehidden":
False,
219 "display_github":
True,
223 "github_user":
"slicer",
224 "github_repo":
"slicer",
225 "github_version":
"main",
226 "conf_py_path":
"/Docs/",
232html_static_path = [
"_static"]
243htmlhelp_basename =
"3DSlicerdoc"
267 (master_doc,
"3DSlicer.tex",
"3D Slicer Documentation",
268 "Slicer Community",
"manual"),
277 (master_doc,
"3Dslicer",
"3D Slicer Documentation",
288 (master_doc,
"3DSlicer",
"3D Slicer Documentation",
289 author,
"3DSlicer",
"One line description of project.",
314docsfolder = os.path.dirname(__file__)
318 os.path.join(docsfolder,
"../Modules/CLI"),
319 os.path.join(docsfolder,
"_extracli"),
326 "TestGridTransformRegistration.xml",
327 "DiffusionTensorTest.xml",
331outpath = os.path.join(docsfolder,
"_moduledescriptions")
332os.makedirs(outpath, exist_ok=
True)
333with open(os.path.join(outpath,
"_readme_.txt"),
"w")
as descriptionfile:
334 descriptionfile.write(
"Content of this folder is automatically generated by Docs/conf.py from CLI module descriptor XML files\n")
335 descriptionfile.write(
"during documentation build. The folder can be deleted because it is automatically regenerated when needed.")
338def _generatemd(dom, docsfolder, outpath, xslt, suffix):
339 """Helper function to create markdown file from CLI module description XML file using XSLT"""
340 xsltpath = os.path.join(docsfolder, xslt)
341 transform = ET.XSLT(ET.parse(xsltpath))
342 content = str(transform(dom))
343 with open(os.path.join(outpath, os.path.splitext(name)[0] + suffix +
".md"),
"w", encoding=
"utf8")
as outfile:
344 outfile.write(content)
347for inputpath
in inputpaths:
348 for root, dirs, files
in os.walk(inputpath):
350 if name
in excludenames:
352 if name.endswith(
".xml"):
353 print(f
"Generating CLI module documentation from {name}")
354 dom = ET.parse(os.path.join(root, name))
355 _generatemd(dom, docsfolder, outpath,
"cli_module_overview_to_md.xsl",
"Overview")
356 _generatemd(dom, docsfolder, outpath,
"cli_module_parameters_to_md.xsl",
"Parameters")
_get_apidocs_doxygen_version()
_extract_slicer_xy_version(slicer_src_dir)