File size: 4,481 Bytes
5ccd75a | 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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | # 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
import subprocess
sys.path.insert(0, os.path.abspath(".."))
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..")))
print(sys.path)
import monai # noqa: E402
# -- Project information -----------------------------------------------------
project = "MONAI"
copyright = "2020 MONAI Consortium"
author = "MONAI Contributors"
# The full version, including alpha/beta/rc tags
short_version = monai.__version__.split("+")[0]
release = short_version
version = short_version
# 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 = [
"transforms",
"networks",
"metrics",
"engines",
"data",
"apps",
"config",
"handlers",
"losses",
"visualize",
"utils",
"inferers",
]
def generate_apidocs(*args):
"""Generate API docs automatically by trawling the available modules"""
module_path = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "monai"))
output_path = os.path.abspath(os.path.join(os.path.dirname(__file__), "apidocs"))
apidoc_command_path = "sphinx-apidoc"
if hasattr(sys, "real_prefix"): # called from a virtualenv
apidoc_command_path = os.path.join(sys.prefix, "bin", "sphinx-apidoc")
apidoc_command_path = os.path.abspath(apidoc_command_path)
print(f"output_path {output_path}")
print(f"module_path {module_path}")
subprocess.check_call(
[apidoc_command_path, "-e"]
+ ["-o", output_path]
+ [module_path]
+ [os.path.join(module_path, p) for p in exclude_patterns]
)
def setup(app):
# Hook to allow for automatic generation of API docs
# before doc deployment begins.
app.connect("builder-inited", generate_apidocs)
# -- 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.
source_suffix = {".rst": "restructuredtext", ".txt": "restructuredtext", ".md": "markdown"}
extensions = [
"recommonmark",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx.ext.autosectionlabel",
"sphinx_autodoc_typehints",
]
autoclass_content = "both"
add_module_names = True
autosectionlabel_prefix_document = True
napoleon_use_param = True
set_type_checking_flag = True
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# -- 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"
# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_theme_options = {
"collapse_navigation": True,
"display_version": True,
"sticky_navigation": True, # Set to False to disable the sticky nav while scrolling.
"logo_only": True, # if we have a html_logo below, this shows /only/ the logo with no title text
"style_nav_header_background": "#FBFBFB",
}
html_context = {
"display_github": True,
"github_user": "Project-MONAI",
"github_repo": "MONAI",
"github_version": "master",
"conf_py_path": "/docs/",
}
html_scaled_image_link = False
html_show_sourcelink = True
html_favicon = "../images/favicon.ico"
html_logo = "../images/MONAI-logo-color.png"
# 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"]
html_css_files = ["custom.css"]
|