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",
50 "user_guide/extensions_manager.html":
"extensions.html#extensions-manager",
59autodoc_mock_imports = [
65myst_enable_extensions = [
75myst_heading_anchors = 6
78myst_dmath_allow_labels =
True
83 Given a Slicer source director, extract <major>.<minor> version
84 from top-level `CMakeLists.txt`.
86 Return a dictionary containing `major` and `minor` version components as strings
88 slicer_src_dir = os.path.abspath(slicer_src_dir)
90 part: re.compile(rf
'set\(Slicer_VERSION_{part.upper()} "(\d+)"\)')
91 for part
in [
"major",
"minor"]
96 cmakelists_path = os.path.join(slicer_src_dir,
"CMakeLists.txt")
97 with open(cmakelists_path)
as cmake_file:
98 for line
in cmake_file:
99 for part, pattern
in version_patterns.items():
100 match = pattern.match(line.strip())
101 if match
is not None:
102 version_parts[part] = match.group(1)
103 if len(version_parts) == len(version_patterns ):
106 if len(version_parts) != len(version_patterns):
107 raise ValueError(f
"Failed to extract version from {cmakelists_path}")
114 Determine the Doxygen documentation version to use based on the Slicer version.
116 Return Doxygen version identifier (`v<major>.<minor>` for Stable, `main` for Preview)
119 slicer_repo_dir = os.path.dirname(os.path.dirname(__file__))
123 is_even = int(version_parts[
"minor"]) % 2 == 0
124 return "v{major}.{minor}".format(**version_parts)
if is_even
else "main"
129print(f
"Slicer API documentation URL scheme: {slicerapidocs_url_scheme}")
139 "slicerapidocs": slicerapidocs_url_scheme,
144templates_path = [
"_templates"]
149source_suffix = [
".rst",
".md"]
156copyright = f
"{date.today().year}, Slicer Community"
157author =
"Slicer Community"
171exclude_patterns = [
"_build",
"Thumbs.db",
".DS_Store",
"_moduledescriptions"]
175if os.environ.get(
"EXCLUDE_API_REFERENCE",
"False") ==
"True":
176 print(
"API reference is excluded from documentation.")
177 exclude_patterns.append(
"developer_guide/vtkTeem.rst")
178 exclude_patterns.append(
"developer_guide/vtkAddon.rst")
179 exclude_patterns.append(
"developer_guide/vtkITK.rst")
180 exclude_patterns.append(
"developer_guide/slicer.rst")
181 exclude_patterns.append(
"developer_guide/mrml.rst")
186 "title":
"Page Not Found",
188<h1>Page Not Found</h1>
189<p>Sorry, we couldn't find that page.</p>
190<p>Try using the search box or go to the homepage.</p>
195pygments_style =
"sphinx"
198todo_include_todos =
False
201rst_prolog = open(
"global.rst.in").read()
205html_logo =
"_static/images/3D-Slicer-Mark.png"
212html_theme =
"sphinx_rtd_theme"
218html_theme_options = {
220 "includehidden":
False,
225 "display_github":
True,
229 "github_user":
"slicer",
230 "github_repo":
"slicer",
231 "github_version":
"main",
232 "conf_py_path":
"/Docs/",
238html_static_path = [
"_static"]
249htmlhelp_basename =
"3DSlicerdoc"
273 (master_doc,
"3DSlicer.tex",
"3D Slicer Documentation",
274 "Slicer Community",
"manual"),
283 (master_doc,
"3Dslicer",
"3D Slicer Documentation",
294 (master_doc,
"3DSlicer",
"3D Slicer Documentation",
295 author,
"3DSlicer",
"One line description of project.",
320docsfolder = os.path.dirname(__file__)
324 os.path.join(docsfolder,
"../Modules/CLI"),
325 os.path.join(docsfolder,
"_extracli"),
332 "TestGridTransformRegistration.xml",
333 "DiffusionTensorTest.xml",
337outpath = os.path.join(docsfolder,
"_moduledescriptions")
338os.makedirs(outpath, exist_ok=
True)
339with open(os.path.join(outpath,
"_readme_.txt"),
"w")
as descriptionfile:
340 descriptionfile.write(
"Content of this folder is automatically generated by Docs/conf.py from CLI module descriptor XML files\n")
341 descriptionfile.write(
"during documentation build. The folder can be deleted because it is automatically regenerated when needed.")
344def _generatemd(dom, docsfolder, outpath, xslt, suffix):
345 """Helper function to create markdown file from CLI module description XML file using XSLT"""
346 xsltpath = os.path.join(docsfolder, xslt)
347 transform = ET.XSLT(ET.parse(xsltpath))
348 content = str(transform(dom))
349 with open(os.path.join(outpath, os.path.splitext(name)[0] + suffix +
".md"),
"w", encoding=
"utf8")
as outfile:
350 outfile.write(content)
353for inputpath
in inputpaths:
354 for root, dirs, files
in os.walk(inputpath):
356 if name
in excludenames:
358 if name.endswith(
".xml"):
359 print(f
"Generating CLI module documentation from {name}")
360 dom = ET.parse(os.path.join(root, name))
361 _generatemd(dom, docsfolder, outpath,
"cli_module_overview_to_md.xsl",
"Overview")
362 _generatemd(dom, docsfolder, outpath,
"cli_module_parameters_to_md.xsl",
"Parameters")
_get_apidocs_doxygen_version()
_extract_slicer_xy_version(slicer_src_dir)