We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Widgets missing from docs
Some widgets seem to have disappeared from the [official docs](http://docs.qtile.org/en/latest/manual/ref/widgets.html) (specifically `Mpris2` and `KeyboardKbdd`).

Given that these are two widgets that I've done some work on, it may be linked to that (but not immediately sure how).

I can do some bisecting and report back.

# Qtile version

Latest (3fb1e46 at time of posting)


EDIT: I can't replicate this on my system. However, given the identity of the two widgets, my guess is that this is related to `dbus-next` and that the modules need to be included in the `docs\conf.py` file here:
https://github.com/qtile/qtile/blob/3fb1e4645910c67bf6d302d59302dfb88f10c4ad/docs/conf.py#L27-L48

I'll submit a PR on that basis.



--- END ISSUE ---

Below are some code segments, each from a relevant file. One or more of these files may contain bugs.
--- BEGIN FILES ---
Path: `docs/conf.py`
Content:
```
1 # -*- coding: utf-8 -*-
2 #
3 # Qtile documentation build configuration file, created by
4 # sphinx-quickstart on Sat Feb 11 15:20:21 2012.
5 #
6 # This file is execfile()d with the current directory set to its containing dir.
7 #
8 # Note that not all possible configuration values are present in this
9 # autogenerated file.
10 #
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
13 
14 import os
15 import setuptools_scm
16 import sys
17 from unittest.mock import MagicMock
18 
19 
20 class Mock(MagicMock):
21     # xcbq does a dir() on objects and pull stuff out of them and tries to sort
22     # the result. MagicMock has a bunch of stuff that can't be sorted, so let's
23     # like about dir().
24     def __dir__(self):
25         return []
26 
27 MOCK_MODULES = [
28     'libqtile._ffi_pango',
29     'libqtile.backend.x11._ffi_xcursors',
30     'cairocffi',
31     'cairocffi.xcb',
32     'cairocffi.pixbuf',
33     'cffi',
34     'dateutil',
35     'dateutil.parser',
36     'iwlib',
37     'keyring',
38     'mpd',
39     'psutil',
40     'trollius',
41     'xcffib',
42     'xcffib.randr',
43     'xcffib.render',
44     'xcffib.xfixes',
45     'xcffib.xinerama',
46     'xcffib.xproto',
47     'xdg.IconTheme',
48 ]
49 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
50 
51 # If extensions (or modules to document with autodoc) are in another directory,
52 # add these directories to sys.path here. If the directory is relative to the
53 # documentation root, use os.path.abspath to make it absolute, like shown here.
54 sys.path.insert(0, os.path.abspath('.'))
55 sys.path.insert(0, os.path.abspath('../'))
56 
57 # -- General configuration -----------------------------------------------------
58 
59 # If your documentation needs a minimal Sphinx version, state it here.
60 #needs_sphinx = '1.0'
61 
62 # Add any Sphinx extension module names here, as strings. They can be extensions
63 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
64 extensions = [
65     'sphinx.ext.autodoc',
66     'sphinx.ext.autosummary',
67     'sphinx.ext.coverage',
68     'sphinx.ext.graphviz',
69     'sphinx.ext.todo',
70     'sphinx.ext.viewcode',
71     'sphinxcontrib.seqdiag',
72     'sphinx_qtile',
73     'numpydoc',
74 ]
75 
76 numpydoc_show_class_members = False
77 
78 # Add any paths that contain templates here, relative to this directory.
79 templates_path = []
80 
81 # The suffix of source filenames.
82 source_suffix = '.rst'
83 
84 # The encoding of source files.
85 #source_encoding = 'utf-8-sig'
86 
87 # The master toctree document.
88 master_doc = 'index'
89 
90 # General information about the project.
91 project = u'Qtile'
92 copyright = u'2008-2020, Aldo Cortesi and contributers'
93 
94 # The version info for the project you're documenting, acts as replacement for
95 # |version| and |release|, also used in various other places throughout the
96 # built documents.
97 #
98 # The short X.Y version.
99 version = setuptools_scm.get_version(root="..")
100 # The full version, including alpha/beta/rc tags.
101 release = version
102 
103 # The language for content autogenerated by Sphinx. Refer to documentation
104 # for a list of supported languages.
105 #language = None
106 
107 # There are two options for replacing |today|: either, you set today to some
108 # non-false value, then it is used:
109 #today = ''
110 # Else, today_fmt is used as the format for a strftime call.
111 #today_fmt = '%B %d, %Y'
112 
113 # List of patterns, relative to source directory, that match files and
114 # directories to ignore when looking for source files.
115 exclude_patterns = ['_build']
116 
117 # The reST default role (used for this markup: `text`) to use for all documents.
118 #default_role = None
119 
120 # If true, '()' will be appended to :func: etc. cross-reference text.
121 #add_function_parentheses = True
122 
123 # If true, the current module name will be prepended to all description
124 # unit titles (such as .. function::).
125 #add_module_names = True
126 
127 # If true, sectionauthor and moduleauthor directives will be shown in the
128 # output. They are ignored by default.
129 #show_authors = False
130 
131 # The name of the Pygments (syntax highlighting) style to use.
132 pygments_style = 'sphinx'
133 
134 # A list of ignored prefixes for module index sorting.
135 #modindex_common_prefix = []
136 
137 # If true, `todo` and `todoList` produce output, else they produce nothing.
138 todo_include_todos = True
139 
140 
141 # -- Options for HTML output --------fautod-------------------------------------------
142 
143 # The theme to use for HTML and HTML Help pages.  See the documentation for
144 # a list of builtin themes.
145 #html_theme = 'default'
146 
147 # Theme options are theme-specific and customize the look and feel of a theme
148 # further.  For a list of options available for each theme, see the
149 # documentation.
150 #html_theme_options = {}
151 
152 # Add any paths that contain custom themes here, relative to this directory.
153 #html_theme_path = []
154 
155 # The name for this set of Sphinx documents.  If None, it defaults to
156 # "<project> v<release> documentation".
157 #html_title = None
158 
159 # A shorter title for the navigation bar.  Default is the same as html_title.
160 #html_short_title = None
161 
162 # The name of an image file (relative to this directory) to place at the top
163 # of the sidebar.
164 #html_logo = None
165 
166 # The name of an image file (within the static path) to use as favicon of the
167 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
168 # pixels large.
169 html_favicon = '_static/favicon.ico'
170 
171 # Add any paths that contain custom static files (such as style sheets) here,
172 # relative to this directory. They are copied after the builtin static files,
173 # so a file named "default.css" will overwrite the builtin "default.css".
174 html_static_path = ['_static']
175 
176 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
177 # using the given strftime format.
178 #html_last_updated_fmt = '%b %d, %Y'
179 
180 # If true, SmartyPants will be used to convert quotes and dashes to
181 # typographically correct entities.
182 #html_use_smartypants = True
183 
184 # Custom sidebar templates, maps document names to template names.
185 #html_sidebars = {}
186 
187 # Additional templates that should be rendered to pages, maps page names to
188 # template names.
189 #html_additional_pages = {'index': 'index.html'}
190 
191 # If false, no module index is generated.
192 #html_domain_indices = True
193 
194 # If false, no index is generated.
195 html_use_index = True
196 
197 # If true, the index is split into individual pages for each letter.
198 #html_split_index = False
199 
200 # If true, links to the reST sources are added to the pages.
201 #html_show_sourcelink = True
202 
203 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
204 #html_show_sphinx = True
205 
206 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
207 #html_show_copyright = True
208 
209 # If true, an OpenSearch description file will be output, and all pages will
210 # contain a <link> tag referring to it.  The value of this option must be the
211 # base URL from which the finished HTML is served.
212 #html_use_opensearch = ''
213 
214 # This is the file name suffix for HTML files (e.g. ".xhtml").
215 #html_file_suffix = None
216 
217 # Output file base name for HTML help builder.
218 htmlhelp_basename = 'Qtiledoc'
219 
220 
221 # -- Options for LaTeX output --------------------------------------------------
222 
223 latex_elements = {
224 # The paper size ('letterpaper' or 'a4paper').
225 #'papersize': 'letterpaper',
226 
227 # The font size ('10pt', '11pt' or '12pt').
228 #'pointsize': '10pt',
229 
230 # Additional stuff for the LaTeX preamble.
231 #'preamble': '',
232 }
233 
234 # Grouping the document tree into LaTeX files. List of tuples
235 # (source start file, target name, title, author, documentclass [howto/manual]).
236 latex_documents = [
237   ('index', 'Qtile.tex', u'Qtile Documentation',
238    u'Aldo Cortesi', 'manual'),
239 ]
240 
241 # The name of an image file (relative to this directory) to place at the top of
242 # the title page.
243 #latex_logo = None
244 
245 # For "manual" documents, if this is true, then toplevel headings are parts,
246 # not chapters.
247 #latex_use_parts = False
248 
249 # If true, show page references after internal links.
250 #latex_show_pagerefs = False
251 
252 # If true, show URL addresses after external links.
253 #latex_show_urls = False
254 
255 # Documents to append as an appendix to all manuals.
256 #latex_appendices = []
257 
258 # If false, no module index is generated.
259 #latex_domain_indices = True
260 
261 
262 # -- Options for manual page output --------------------------------------------
263 
264 # One entry per manual page. List of tuples
265 # (source start file, name, description, authors, manual section).
266 #man_pages = []
267 
268 # If true, show URL addresses after external links.
269 #man_show_urls = False
270 
271 
272 # -- Options for Texinfo output ------------------------------------------------
273 
274 # Grouping the document tree into Texinfo files. List of tuples
275 # (source start file, target name, title, author,
276 #  dir menu entry, description, category)
277 texinfo_documents = [
278   ('index', 'Qtile', u'Qtile Documentation',
279    u'Aldo Cortesi', 'Qtile', 'A hackable tiling window manager.',
280    'Miscellaneous'),
281 ]
282 
283 # Documents to append as an appendix to all manuals.
284 #texinfo_appendices = []
285 
286 # If false, no module index is generated.
287 #texinfo_domain_indices = True
288 
289 # How to display URL addresses: 'footnote', 'no', or 'inline'.
290 #texinfo_show_urls = 'footnote'
291 
292 # only import and set the theme if we're building docs locally
293 if not os.environ.get('READTHEDOCS'):
294     import sphinx_rtd_theme
295     html_theme = 'sphinx_rtd_theme'
296     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
297 
298 
299 graphviz_dot_args = ['-Lg']
300 
301 # A workaround for the responsive tables always having annoying scrollbars.
302 def setup(app):
303     app.add_css_file("no_scrollbars.css")
304
```
--- END FILES ---

Please first localize the bug based on the issue statement, and then generate a patch according to the `git diff` format fenced by three backticks.

Here is an example:

```diff
diff --git a/examples/server_async.py b/examples/server_async.py
--- a/examples/server_async.py
+++ b/examples/server_async.py
@@ -313,4 +313,4 @@
 
 
 if __name__ == "__main__":
-    asyncio.run(run_async_server("."), debug=True)
+    asyncio.run(run_async_server(), debug=True)
diff --git a/examples/server_sync.py b/examples/server_sync.py
--- a/examples/server_sync.py
+++ b/examples/server_sync.py
@@ -313,5 +313,5 @@
 
 
 if __name__ == "__main__":
-    server = run_sync_server(".")
+    server = run_sync_server()
     server.shutdown()

```

diff --git a/docs/conf.py b/docs/conf.py
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -33,6 +33,10 @@
     'cffi',
     'dateutil',
     'dateutil.parser',
+    'dbus_next',
+    'dbus_next.aio',
+    'dbus_next.service',
+    'dbus_next.constants',
     'iwlib',
     'keyring',
     'mpd',

{"golden_diff": "diff --git a/docs/conf.py b/docs/conf.py\n--- a/docs/conf.py\n+++ b/docs/conf.py\n@@ -33,6 +33,10 @@\n     'cffi',\n     'dateutil',\n     'dateutil.parser',\n+    'dbus_next',\n+    'dbus_next.aio',\n+    'dbus_next.service',\n+    'dbus_next.constants',\n     'iwlib',\n     'keyring',\n     'mpd',\n", "issue": "Widgets missing from docs\nSome widgets seem to have disappeared from the [official docs](http://docs.qtile.org/en/latest/manual/ref/widgets.html) (specifically `Mpris2` and `KeyboardKbdd`).\r\n\r\nGiven that these are two widgets that I've done some work on, it may be linked to that (but not immediately sure how).\r\n\r\nI can do some bisecting and report back.\r\n\r\n# Qtile version\r\n\r\nLatest (3fb1e46 at time of posting)\r\n\r\n\r\nEDIT: I can't replicate this on my system. However, given the identity of the two widgets, my guess is that this is related to `dbus-next` and that the modules need to be included in the `docs\\conf.py` file here:\r\nhttps://github.com/qtile/qtile/blob/3fb1e4645910c67bf6d302d59302dfb88f10c4ad/docs/conf.py#L27-L48\r\n\r\nI'll submit a PR on that basis.\r\n\r\n\n", "before_files": [{"content": "# -*- coding: utf-8 -*-\n#\n# Qtile documentation build configuration file, created by\n# sphinx-quickstart on Sat Feb 11 15:20:21 2012.\n#\n# This file is execfile()d with the current directory set to its containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport os\nimport setuptools_scm\nimport sys\nfrom unittest.mock import MagicMock\n\n\nclass Mock(MagicMock):\n    # xcbq does a dir() on objects and pull stuff out of them and tries to sort\n    # the result. MagicMock has a bunch of stuff that can't be sorted, so let's\n    # like about dir().\n    def __dir__(self):\n        return []\n\nMOCK_MODULES = [\n    'libqtile._ffi_pango',\n    'libqtile.backend.x11._ffi_xcursors',\n    'cairocffi',\n    'cairocffi.xcb',\n    'cairocffi.pixbuf',\n    'cffi',\n    'dateutil',\n    'dateutil.parser',\n    'iwlib',\n    'keyring',\n    'mpd',\n    'psutil',\n    'trollius',\n    'xcffib',\n    'xcffib.randr',\n    'xcffib.render',\n    'xcffib.xfixes',\n    'xcffib.xinerama',\n    'xcffib.xproto',\n    'xdg.IconTheme',\n]\nsys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.insert(0, os.path.abspath('.'))\nsys.path.insert(0, os.path.abspath('../'))\n\n# -- General configuration -----------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be extensions\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\nextensions = [\n    'sphinx.ext.autodoc',\n    'sphinx.ext.autosummary',\n    'sphinx.ext.coverage',\n    'sphinx.ext.graphviz',\n    'sphinx.ext.todo',\n    'sphinx.ext.viewcode',\n    'sphinxcontrib.seqdiag',\n    'sphinx_qtile',\n    'numpydoc',\n]\n\nnumpydoc_show_class_members = False\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = []\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'Qtile'\ncopyright = u'2008-2020, Aldo Cortesi and contributers'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = setuptools_scm.get_version(root=\"..\")\n# The full version, including alpha/beta/rc tags.\nrelease = version\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = ['_build']\n\n# The reST default role (used for this markup: `text`) to use for all documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = True\n\n\n# -- Options for HTML output --------fautod-------------------------------------------\n\n# The theme to use for HTML and HTML Help pages.  See the documentation for\n# a list of builtin themes.\n#html_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further.  For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents.  If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar.  Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\nhtml_favicon = '_static/favicon.ico'\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {'index': 'index.html'}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\nhtml_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it.  The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'Qtiledoc'\n\n\n# -- Options for LaTeX output --------------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title, author, documentclass [howto/manual]).\nlatex_documents = [\n  ('index', 'Qtile.tex', u'Qtile Documentation',\n   u'Aldo Cortesi', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\n\n\n# -- Options for manual page output --------------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\n#man_pages = []\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\n\n\n# -- Options for Texinfo output ------------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n#  dir menu entry, description, category)\ntexinfo_documents = [\n  ('index', 'Qtile', u'Qtile Documentation',\n   u'Aldo Cortesi', 'Qtile', 'A hackable tiling window manager.',\n   'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\n# only import and set the theme if we're building docs locally\nif not os.environ.get('READTHEDOCS'):\n    import sphinx_rtd_theme\n    html_theme = 'sphinx_rtd_theme'\n    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]\n\n\ngraphviz_dot_args = ['-Lg']\n\n# A workaround for the responsive tables always having annoying scrollbars.\ndef setup(app):\n    app.add_css_file(\"no_scrollbars.css\")\n", "path": "docs/conf.py"}], "after_files": [{"content": "# -*- coding: utf-8 -*-\n#\n# Qtile documentation build configuration file, created by\n# sphinx-quickstart on Sat Feb 11 15:20:21 2012.\n#\n# This file is execfile()d with the current directory set to its containing dir.\n#\n# Note that not all possible configuration values are present in this\n# autogenerated file.\n#\n# All configuration values have a default; values that are commented out\n# serve to show the default.\n\nimport os\nimport setuptools_scm\nimport sys\nfrom unittest.mock import MagicMock\n\n\nclass Mock(MagicMock):\n    # xcbq does a dir() on objects and pull stuff out of them and tries to sort\n    # the result. MagicMock has a bunch of stuff that can't be sorted, so let's\n    # like about dir().\n    def __dir__(self):\n        return []\n\nMOCK_MODULES = [\n    'libqtile._ffi_pango',\n    'libqtile.backend.x11._ffi_xcursors',\n    'cairocffi',\n    'cairocffi.xcb',\n    'cairocffi.pixbuf',\n    'cffi',\n    'dateutil',\n    'dateutil.parser',\n    'dbus_next',\n    'dbus_next.aio',\n    'dbus_next.service',\n    'dbus_next.constants',\n    'iwlib',\n    'keyring',\n    'mpd',\n    'psutil',\n    'trollius',\n    'xcffib',\n    'xcffib.randr',\n    'xcffib.render',\n    'xcffib.xfixes',\n    'xcffib.xinerama',\n    'xcffib.xproto',\n    'xdg.IconTheme',\n]\nsys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)\n\n# If extensions (or modules to document with autodoc) are in another directory,\n# add these directories to sys.path here. If the directory is relative to the\n# documentation root, use os.path.abspath to make it absolute, like shown here.\nsys.path.insert(0, os.path.abspath('.'))\nsys.path.insert(0, os.path.abspath('../'))\n\n# -- General configuration -----------------------------------------------------\n\n# If your documentation needs a minimal Sphinx version, state it here.\n#needs_sphinx = '1.0'\n\n# Add any Sphinx extension module names here, as strings. They can be extensions\n# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.\nextensions = [\n    'sphinx.ext.autodoc',\n    'sphinx.ext.autosummary',\n    'sphinx.ext.coverage',\n    'sphinx.ext.graphviz',\n    'sphinx.ext.todo',\n    'sphinx.ext.viewcode',\n    'sphinxcontrib.seqdiag',\n    'sphinx_qtile',\n    'numpydoc',\n]\n\nnumpydoc_show_class_members = False\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = []\n\n# The suffix of source filenames.\nsource_suffix = '.rst'\n\n# The encoding of source files.\n#source_encoding = 'utf-8-sig'\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# General information about the project.\nproject = u'Qtile'\ncopyright = u'2008-2020, Aldo Cortesi and contributers'\n\n# The version info for the project you're documenting, acts as replacement for\n# |version| and |release|, also used in various other places throughout the\n# built documents.\n#\n# The short X.Y version.\nversion = setuptools_scm.get_version(root=\"..\")\n# The full version, including alpha/beta/rc tags.\nrelease = version\n\n# The language for content autogenerated by Sphinx. Refer to documentation\n# for a list of supported languages.\n#language = None\n\n# There are two options for replacing |today|: either, you set today to some\n# non-false value, then it is used:\n#today = ''\n# Else, today_fmt is used as the format for a strftime call.\n#today_fmt = '%B %d, %Y'\n\n# List of patterns, relative to source directory, that match files and\n# directories to ignore when looking for source files.\nexclude_patterns = ['_build']\n\n# The reST default role (used for this markup: `text`) to use for all documents.\n#default_role = None\n\n# If true, '()' will be appended to :func: etc. cross-reference text.\n#add_function_parentheses = True\n\n# If true, the current module name will be prepended to all description\n# unit titles (such as .. function::).\n#add_module_names = True\n\n# If true, sectionauthor and moduleauthor directives will be shown in the\n# output. They are ignored by default.\n#show_authors = False\n\n# The name of the Pygments (syntax highlighting) style to use.\npygments_style = 'sphinx'\n\n# A list of ignored prefixes for module index sorting.\n#modindex_common_prefix = []\n\n# If true, `todo` and `todoList` produce output, else they produce nothing.\ntodo_include_todos = True\n\n\n# -- Options for HTML output --------fautod-------------------------------------------\n\n# The theme to use for HTML and HTML Help pages.  See the documentation for\n# a list of builtin themes.\n#html_theme = 'default'\n\n# Theme options are theme-specific and customize the look and feel of a theme\n# further.  For a list of options available for each theme, see the\n# documentation.\n#html_theme_options = {}\n\n# Add any paths that contain custom themes here, relative to this directory.\n#html_theme_path = []\n\n# The name for this set of Sphinx documents.  If None, it defaults to\n# \"<project> v<release> documentation\".\n#html_title = None\n\n# A shorter title for the navigation bar.  Default is the same as html_title.\n#html_short_title = None\n\n# The name of an image file (relative to this directory) to place at the top\n# of the sidebar.\n#html_logo = None\n\n# The name of an image file (within the static path) to use as favicon of the\n# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32\n# pixels large.\nhtml_favicon = '_static/favicon.ico'\n\n# Add any paths that contain custom static files (such as style sheets) here,\n# relative to this directory. They are copied after the builtin static files,\n# so a file named \"default.css\" will overwrite the builtin \"default.css\".\nhtml_static_path = ['_static']\n\n# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,\n# using the given strftime format.\n#html_last_updated_fmt = '%b %d, %Y'\n\n# If true, SmartyPants will be used to convert quotes and dashes to\n# typographically correct entities.\n#html_use_smartypants = True\n\n# Custom sidebar templates, maps document names to template names.\n#html_sidebars = {}\n\n# Additional templates that should be rendered to pages, maps page names to\n# template names.\n#html_additional_pages = {'index': 'index.html'}\n\n# If false, no module index is generated.\n#html_domain_indices = True\n\n# If false, no index is generated.\nhtml_use_index = True\n\n# If true, the index is split into individual pages for each letter.\n#html_split_index = False\n\n# If true, links to the reST sources are added to the pages.\n#html_show_sourcelink = True\n\n# If true, \"Created using Sphinx\" is shown in the HTML footer. Default is True.\n#html_show_sphinx = True\n\n# If true, \"(C) Copyright ...\" is shown in the HTML footer. Default is True.\n#html_show_copyright = True\n\n# If true, an OpenSearch description file will be output, and all pages will\n# contain a <link> tag referring to it.  The value of this option must be the\n# base URL from which the finished HTML is served.\n#html_use_opensearch = ''\n\n# This is the file name suffix for HTML files (e.g. \".xhtml\").\n#html_file_suffix = None\n\n# Output file base name for HTML help builder.\nhtmlhelp_basename = 'Qtiledoc'\n\n\n# -- Options for LaTeX output --------------------------------------------------\n\nlatex_elements = {\n# The paper size ('letterpaper' or 'a4paper').\n#'papersize': 'letterpaper',\n\n# The font size ('10pt', '11pt' or '12pt').\n#'pointsize': '10pt',\n\n# Additional stuff for the LaTeX preamble.\n#'preamble': '',\n}\n\n# Grouping the document tree into LaTeX files. List of tuples\n# (source start file, target name, title, author, documentclass [howto/manual]).\nlatex_documents = [\n  ('index', 'Qtile.tex', u'Qtile Documentation',\n   u'Aldo Cortesi', 'manual'),\n]\n\n# The name of an image file (relative to this directory) to place at the top of\n# the title page.\n#latex_logo = None\n\n# For \"manual\" documents, if this is true, then toplevel headings are parts,\n# not chapters.\n#latex_use_parts = False\n\n# If true, show page references after internal links.\n#latex_show_pagerefs = False\n\n# If true, show URL addresses after external links.\n#latex_show_urls = False\n\n# Documents to append as an appendix to all manuals.\n#latex_appendices = []\n\n# If false, no module index is generated.\n#latex_domain_indices = True\n\n\n# -- Options for manual page output --------------------------------------------\n\n# One entry per manual page. List of tuples\n# (source start file, name, description, authors, manual section).\n#man_pages = []\n\n# If true, show URL addresses after external links.\n#man_show_urls = False\n\n\n# -- Options for Texinfo output ------------------------------------------------\n\n# Grouping the document tree into Texinfo files. List of tuples\n# (source start file, target name, title, author,\n#  dir menu entry, description, category)\ntexinfo_documents = [\n  ('index', 'Qtile', u'Qtile Documentation',\n   u'Aldo Cortesi', 'Qtile', 'A hackable tiling window manager.',\n   'Miscellaneous'),\n]\n\n# Documents to append as an appendix to all manuals.\n#texinfo_appendices = []\n\n# If false, no module index is generated.\n#texinfo_domain_indices = True\n\n# How to display URL addresses: 'footnote', 'no', or 'inline'.\n#texinfo_show_urls = 'footnote'\n\n# only import and set the theme if we're building docs locally\nif not os.environ.get('READTHEDOCS'):\n    import sphinx_rtd_theme\n    html_theme = 'sphinx_rtd_theme'\n    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]\n\n\ngraphviz_dot_args = ['-Lg']\n\n# A workaround for the responsive tables always having annoying scrollbars.\ndef setup(app):\n    app.add_css_file(\"no_scrollbars.css\")\n", "path": "docs/conf.py"}]}