5
5
ROOT = Path (__file__ ).parent .parent
6
6
PACKAGE_SRC = ROOT / "jsonschema"
7
7
8
- # -- Project information -----------------------------------------------------
9
-
10
8
project = "jsonschema"
11
9
author = "Julian Berman"
12
10
copyright = "2013, " + author
13
11
14
- # version: The short X.Y version
15
- # release: The full version, including alpha/beta/rc tags.
16
12
release = importlib .metadata .version ("jsonschema" )
17
13
version = release .partition ("-" )[0 ]
18
14
19
-
20
- # -- General configuration ---------------------------------------------------
21
-
22
- # If your documentation needs a minimal Sphinx version, state it here.
23
- #
24
- # needs_sphinx = "1.0"
25
-
15
+ language = "en"
26
16
default_role = "any"
27
17
28
- # Add any Sphinx extension module names here, as strings. They can be
29
- # extensions coming with Sphinx (named "sphinx.ext.*") or your custom
30
- # ones.
31
18
extensions = [
32
19
"sphinx.ext.autodoc" ,
33
20
"sphinx.ext.autosectionlabel" ,
47
34
48
35
cache_path = "_cache"
49
36
50
- # Add any paths that contain templates here, relative to this directory.
51
- templates_path = ["_templates" ]
52
-
53
- # The suffix(es) of source filenames.
54
- # You can specify multiple suffix as a list of string:
55
- #
56
- # source_suffix = [".rst", ".md"]
57
- source_suffix = ".rst"
58
-
59
- # The master toctree document.
60
- master_doc = "index"
61
-
62
- # There are two options for replacing |today|: either, you set today to some
63
- # non-false value, then it is used:
64
- # today = ""
65
- # Else, today_fmt is used as the format for a strftime call.
66
- # today_fmt = "%B %d, %Y"
67
-
68
- # List of patterns, relative to source directory, that match files and
69
- # directories to ignore when looking for source files.
70
- # This pattern also affects html_static_path and html_extra_path.
71
- exclude_patterns = ["_build" , "_cache" , "_static" , "_templates" ]
72
-
73
- # The name of the Pygments (syntax highlighting) style to use.
74
37
pygments_style = "lovelace"
75
38
pygments_dark_style = "one-dark"
76
39
77
- doctest_global_setup = """
78
- from jsonschema import *
79
- """
80
-
81
- intersphinx_mapping = {
82
- "python" : ("https://docs.python.org/3" , None ),
83
- "ujs" : ("https://json-schema.org/understanding-json-schema/" , None ),
84
- }
85
-
86
-
87
- # -- Options for HTML output -----------------------------------------------
88
-
89
- # The theme to use for HTML and HTML Help pages. See the documentation for
90
- # a list of builtin themes.
91
40
html_theme = "furo"
92
41
93
- # Theme options are theme-specific and customize the look and feel of a theme
94
- # further. For a list of options available for each theme, see the
95
- # documentation.
96
- #
97
- # html_theme_options = {}
98
-
99
- # Add any paths that contain custom static files (such as style sheets) here,
100
- # relative to this directory. They are copied after the builtin static files,
101
- # so a file named "default.css" will overwrite the builtin "default.css".
102
- # html_static_path = ["_static"]
103
-
104
-
105
- # -- Options for HTMLHelp output ---------------------------------------------
106
-
107
- # Output file base name for HTML help builder.
108
- htmlhelp_basename = "jsonschemadoc"
109
-
110
-
111
- # -- Options for LaTeX output ------------------------------------------------
112
-
113
- latex_documents = [
114
- ("index" , "jsonschema.tex" , "jsonschema Documentation" , author , "manual" ),
115
- ]
42
+ # = Builders =
116
43
117
-
118
- # -- Options for manual page output ------------------------------------------
119
-
120
- # One entry per manual page. List of tuples
121
- # (source start file, name, description, authors, manual section).
122
- man_pages = [("index" , "jsonschema" , "jsonschema Documentation" , [author ], 1 )]
123
-
124
-
125
- # -- Options for Texinfo output ----------------------------------------------
126
-
127
- # Grouping the document tree into Texinfo files. List of tuples
128
- # (source start file, target name, title, author,
129
- # dir menu entry, description, category)
130
- texinfo_documents = [
131
- (
132
- "index" ,
133
- "jsonschema" ,
134
- "jsonschema Documentation" ,
135
- author ,
136
- "jsonschema" ,
137
- "One line description of project." ,
138
- "Miscellaneous" ,
139
- ),
140
- ]
141
-
142
- # -- Options for the linkcheck builder --------------------------------------
44
+ doctest_global_setup = """
45
+ from jsonschema import *
46
+ """
143
47
144
48
145
49
def entire_domain (host ):
@@ -152,15 +56,9 @@ def entire_domain(host):
152
56
"https://github.com/python-jsonschema/jsonschema/workflows/CI/badge.svg" ,
153
57
]
154
58
155
- # -- Options for sphinxcontrib-autosectionlabel ---------------------------
59
+ # = Extensions =
156
60
157
- autosectionlabel_prefix_document = True
158
-
159
- # -- Options for sphinxcontrib-spelling -----------------------------------
160
-
161
- spelling_word_list_filename = "spelling-wordlist.txt"
162
-
163
- # -- Options for autoapi ----------------------------------------------------
61
+ # -- autoapi --
164
62
165
63
suppress_warnings = [
166
64
"autoapi.python_import_resolution" ,
@@ -184,3 +82,19 @@ def entire_domain(host):
184
82
185
83
autoapi_type = "python"
186
84
autoapi_dirs = [PACKAGE_SRC ]
85
+
86
+ # -- autosectionlabel --
87
+
88
+ autosectionlabel_prefix_document = True
89
+
90
+ # -- intersphinx --
91
+
92
+ intersphinx_mapping = {
93
+ "python" : ("https://docs.python.org/3" , None ),
94
+ "ujs" : ("https://json-schema.org/understanding-json-schema/" , None ),
95
+ }
96
+
97
+ # -- sphinxcontrib-spelling --
98
+
99
+ spelling_word_list_filename = "spelling-wordlist.txt"
100
+ spelling_show_suggestions = True
0 commit comments