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
|
# 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 sphinx_rtd_theme
from importlib import metadata
sys.path.insert(0, os.path.abspath(".."))
sys.path.append(os.path.abspath("_ext"))
# sys.path.append(os.abspath(os.join(os.dirname(__file__), "_ext")))
project = "xsData"
copyright = "2021, Christodoulos Tsoulloftas"
author = "Christodoulos Tsoulloftas"
# The full version, including alpha/beta/rc tags
version = release = metadata.version("xsdata")
# -- 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 = [
"xsdatadocs",
"sphinx.ext.doctest",
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.autosectionlabel",
"sphinx.ext.viewcode",
"sphinx.ext.autosummary",
"sphinx_autodoc_typehints",
"sphinx_inline_tabs",
"sphinx_copybutton",
]
# 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 -------------------------------------------------
# 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"]
# Required theme setup
# extensions.append("sphinx_material")
html_theme = "sphinx_rtd_theme"
html_theme_path = sphinx_rtd_theme.get_html_theme_path()
html_favicon = "_static/favicon.png"
html_theme_options = {
"sidebar_hide_name": True,
"light_logo": "logo.svg",
"dark_logo": "logo-dark.svg",
}
html_show_sourcelink = True
html_extra_path = ["robots.txt"]
def check_object_path(key, url, path):
if os.path.isfile(path):
return {key: (url, path)}
return {}
intersphinx_mapping = {}
intersphinx_mapping.update(
check_object_path(
'python',
'https://docs.python.org/',
'/usr/share/doc/python' + '.'.join([str(x) for x in sys.version_info[0:2]]) + '/html/objects.inv'
)
)
intersphinx_mapping.update(
check_object_path(
'lxml',
'https://lxml.de/apidoc/',
'/usr/share/doc/python-lxml/html/apidoc//objects.inv'
)
)
autodoc_default_options = {
"member-order": "bysource",
"special-members": None,
# Exclude "standard" methods.
"exclude-members": "__dict__,__weakref__,__init__,__repr__,__new__",
}
autosummary_generate = True
set_type_checking_flag = True
always_document_param_types = False
master_doc = 'index'
|
