Repository navigation
Expand file tree
/
Copy pathconf.py
More file actions
104 lines (85 loc) · 3.02 KB
/
Copy pathconf.py
File metadata and controls
104 lines (85 loc) · 3.02 KB
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
# 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
# -- General configuration ---------------------------------------------------
import sys
import os
from multiproject.utils import get_project
sys.path.insert(0, os.path.abspath('.'))
# NB: sphinx_charts imports pkg_resources, which was removed in setuptools 81.
# Provide a minimal stand-in for the one function it uses.
try:
import pkg_resources
except ImportError:
import types
from importlib.resources import files
pkg_resources = types.ModuleType("pkg_resources")
pkg_resources.resource_filename = lambda pkg, path: str(files(pkg) / path)
sys.modules["pkg_resources"] = pkg_resources
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"multiproject",
"sphinx.ext.intersphinx",
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx_search.extension",
"sphinx_tabs.tabs",
"sphinx_charts.charts",
"sphinx_copybutton",
"myst_nb",
# NB: Needed for newer sphinx versions - see
# https://github.com/thclark/sphinx-charts/issues/23
"sphinxcontrib.jquery"
]
multiproject_projects = {
"ops": {
"path": "ops/doc/",
"config": {
"project": "SciJava Ops documentation",
"html_title": "SciJava Ops documentation",
},
},
}
docset = get_project(multiproject_projects)
# 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",
"README.md",
"examples/README.md",
"migration.md",
"migration-plan.md",
"versioning.md",
]
# -- MyST-Parser/MyST-NB configuration ---------------------------------------
myst_heading_anchors = 4
nb_execution_mode = "off"
# -- Custom Lexers -----------------------------------------------------------
from lexers import SciJavaGroovyLexer
def setup(app):
app.add_lexer('scijava-groovy', SciJavaGroovyLexer)
# -- 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 = []
html_extra_path = ["ops/doc/404.html"]
# Add the SciJava ops logo
html_logo = "ops/images/scijava-ops.svg"
html_theme_options = {
"logo_only": True,
"display_version": False,
}