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
|
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Doxygen generation
from pathlib import Path
import subprocess
this_folder = Path(__file__).parent
def configureDoxyfile(input_dir, output_dir):
with open(this_folder/'Doxyfile.in', 'r') as file :
filedata = file.read()
filedata = filedata.replace('@CMAKE_SOURCE_DIR@', str(input_dir))
filedata = filedata.replace('@CMAKE_CURRENT_BINARY_DIR@', str(output_dir))
with open('Doxyfile', 'w') as file:
file.write(filedata)
doxygen_inputdir = (this_folder/"..").resolve()
doxygen_output = (this_folder/"doxygen").resolve()
if not Path(this_folder/"doxygen").exists():
configureDoxyfile(doxygen_inputdir, doxygen_output)
subprocess.check_call('doxygen', cwd=this_folder)
breathe_projects = {'ISMRMRD': str(doxygen_output/"xml")}
breathe_default_project = 'ISMRMRD'
# -- Project information -----------------------------------------------------
project = 'ISMRMRD'
copyright = '2022, ISMRMRD Working Group'
author = 'ISMRMRD Working Group'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['breathe', 'myst_parser', 'sphinxcontrib.mermaid']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Override wide tables issue: https://github.com/readthedocs/sphinx_rtd_theme/issues/117
# html_context = {
# 'css_files': [
# '_static/theme_overrides.css', # overrides for wide tables in RTD theme
# ],
# }
html_css_files = [
'css/custom.css',
]
# -- Custom CSS --------------------------------------------------------------
# def setup(app):
# app.add_javascript("custom.js")
# app.add_css_file("theme_overrides.css")
|
