|
23 | 23 |
|
24 | 24 | # Add any Sphinx extension module names here, as strings. They can be extensions |
25 | 25 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
26 | | -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] |
| 26 | +extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx"] |
27 | 27 |
|
28 | 28 | # Add any paths that contain templates here, relative to this directory. |
29 | | -templates_path = ['_templates'] |
| 29 | +templates_path = ["_templates"] |
30 | 30 |
|
31 | 31 | # The suffix of source filenames. |
32 | | -source_suffix = '.rst' |
| 32 | +source_suffix = ".rst" |
33 | 33 |
|
34 | 34 | # The encoding of source files. |
35 | 35 | # source_encoding = 'utf-8-sig' |
36 | 36 |
|
37 | 37 | # The master toctree document. |
38 | | -master_doc = 'index' |
| 38 | +master_doc = "index" |
39 | 39 |
|
40 | 40 | # General information about the project. |
41 | | -project = 'python-zeroconf' |
42 | | -copyright = 'python-zeroconf authors' |
| 41 | +project = "python-zeroconf" |
| 42 | +copyright = "python-zeroconf authors" |
43 | 43 |
|
44 | 44 | # The version info for the project you're documenting, acts as replacement for |
45 | 45 | # |version| and |release|, also used in various other places throughout the |
|
62 | 62 |
|
63 | 63 | # List of patterns, relative to source directory, that match files and |
64 | 64 | # directories to ignore when looking for source files. |
65 | | -exclude_patterns = ['_build'] |
| 65 | +exclude_patterns = ["_build"] |
66 | 66 |
|
67 | 67 | # The reST default role (used for this markup: `text`) to use for all documents. |
68 | 68 | # default_role = None |
|
79 | 79 | # show_authors = False |
80 | 80 |
|
81 | 81 | # The name of the Pygments (syntax highlighting) style to use. |
82 | | -pygments_style = 'sphinx' |
| 82 | +pygments_style = "sphinx" |
83 | 83 |
|
84 | 84 | # A list of ignored prefixes for module index sorting. |
85 | 85 | # modindex_common_prefix = [] |
|
92 | 92 |
|
93 | 93 | # The theme to use for HTML and HTML Help pages. See the documentation for |
94 | 94 | # a list of builtin themes. |
95 | | -html_theme = 'default' |
| 95 | +html_theme = "default" |
96 | 96 |
|
97 | 97 | # Theme options are theme-specific and customize the look and feel of a theme |
98 | 98 | # further. For a list of options available for each theme, see the |
|
121 | 121 | # Add any paths that contain custom static files (such as style sheets) here, |
122 | 122 | # relative to this directory. They are copied after the builtin static files, |
123 | 123 | # so a file named "default.css" will overwrite the builtin "default.css". |
124 | | -html_static_path = ['_static'] |
| 124 | +html_static_path = ["_static"] |
125 | 125 |
|
126 | 126 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
127 | 127 | # using the given strftime format. |
|
133 | 133 |
|
134 | 134 | # Custom sidebar templates, maps document names to template names. |
135 | 135 | html_sidebars = { |
136 | | - 'index': ('sidebar.html', 'sourcelink.html', 'searchbox.html'), |
137 | | - '**': ('localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'), |
| 136 | + "index": ("sidebar.html", "sourcelink.html", "searchbox.html"), |
| 137 | + "**": ("localtoc.html", "relations.html", "sourcelink.html", "searchbox.html"), |
138 | 138 | } |
139 | 139 |
|
140 | 140 | # Additional templates that should be rendered to pages, maps page names to |
|
168 | 168 | # html_file_suffix = None |
169 | 169 |
|
170 | 170 | # Output file base name for HTML help builder. |
171 | | -htmlhelp_basename = 'zeroconfdoc' |
| 171 | +htmlhelp_basename = "zeroconfdoc" |
172 | 172 |
|
173 | 173 |
|
174 | 174 | # -- Options for LaTeX output -------------------------------------------------- |
|
231 | 231 |
|
232 | 232 |
|
233 | 233 | # Example configuration for intersphinx: refer to the Python standard library. |
234 | | -intersphinx_mapping = {'http://docs.python.org/': None} |
| 234 | +intersphinx_mapping = {"http://docs.python.org/": None} |
235 | 235 |
|
236 | 236 |
|
237 | 237 | def setup(app): # type: ignore[no-untyped-def] |
238 | | - app.connect('autodoc-skip-member', skip_member) |
| 238 | + app.connect("autodoc-skip-member", skip_member) |
239 | 239 |
|
240 | 240 |
|
241 | 241 | def skip_member(app, what, name, obj, skip, options): # type: ignore[no-untyped-def] |
242 | 242 | return ( |
243 | 243 | skip |
244 | | - or getattr(obj, '__doc__', None) is None |
245 | | - or getattr(obj, '__private__', False) is True |
246 | | - or getattr(getattr(obj, '__func__', None), '__private__', False) is True |
| 244 | + or getattr(obj, "__doc__", None) is None |
| 245 | + or getattr(obj, "__private__", False) is True |
| 246 | + or getattr(getattr(obj, "__func__", None), "__private__", False) is True |
247 | 247 | ) |
0 commit comments