We are currently solving the following issue within our repository. Here is the issue text:
--- BEGIN ISSUE ---
Docs: Config file deprecation warnings
* [x] Upgrade v1 docs to clearly indicate that it's removed in September 2023 and link to the v2 version
* [x] Add warning banners in various places

References https://github.com/readthedocs/readthedocs.org/issues/10342

--- 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 """
2 Shared Sphinx configuration using sphinx-multiproject.
3 
4 To build each project, the ``PROJECT`` environment variable is used.
5 
6 .. code:: console
7 
8    $ make html  # build default project
9    $ PROJECT=dev make html  # build the dev project
10 
11 for more information read https://sphinx-multiproject.readthedocs.io/.
12 """
13 
14 import os
15 import sys
16 
17 from multiproject.utils import get_project
18 
19 sys.path.append(os.path.abspath("_ext"))
20 extensions = [
21     "hoverxref.extension",
22     "multiproject",
23     "myst_parser",
24     "notfound.extension",
25     "sphinx_design",
26     "sphinx_search.extension",
27     "sphinx_tabs.tabs",
28     "sphinx-prompt",
29     "sphinx.ext.autodoc",
30     "sphinx.ext.autosectionlabel",
31     "sphinx.ext.extlinks",
32     "sphinx.ext.intersphinx",
33     "sphinxcontrib.httpdomain",
34     "sphinxcontrib.video",
35     "sphinxemoji.sphinxemoji",
36     "sphinxext.opengraph",
37 ]
38 
39 multiproject_projects = {
40     "user": {
41         "use_config_file": False,
42         "config": {
43             "project": "Read the Docs user documentation",
44         },
45     },
46     "dev": {
47         "use_config_file": False,
48         "config": {
49             "project": "Read the Docs developer documentation",
50         },
51     },
52 }
53 
54 docset = get_project(multiproject_projects)
55 
56 ogp_site_name = "Read the Docs Documentation"
57 ogp_use_first_image = True  # https://github.com/readthedocs/blog/pull/118
58 ogp_image = "https://docs.readthedocs.io/en/latest/_static/img/logo-opengraph.png"
59 # Inspired by https://github.com/executablebooks/MyST-Parser/pull/404/
60 ogp_custom_meta_tags = [
61     '<meta name="twitter:card" content="summary_large_image" />',
62 ]
63 ogp_enable_meta_description = True
64 ogp_description_length = 300
65 
66 templates_path = ["_templates"]
67 
68 # This may be elevated as a general issue for documentation and behavioral
69 # change to the Sphinx build:
70 # This will ensure that we use the correctly set environment for canonical URLs
71 # Old Read the Docs injections makes it point only to the default version,
72 # for instance /en/stable/
73 html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "/")
74 
75 master_doc = "index"
76 copyright = "Read the Docs, Inc & contributors"
77 version = "9.13.2"
78 release = version
79 exclude_patterns = ["_build", "shared", "_includes"]
80 default_role = "obj"
81 intersphinx_cache_limit = 14  # cache for 2 weeks
82 intersphinx_timeout = 3  # 3 seconds timeout
83 intersphinx_mapping = {
84     "python": ("https://docs.python.org/3.10/", None),
85     "django": (
86         "https://docs.djangoproject.com/en/stable/",
87         "https://docs.djangoproject.com/en/stable/_objects/",
88     ),
89     "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
90     "pip": ("https://pip.pypa.io/en/stable/", None),
91     "nbsphinx": ("https://nbsphinx.readthedocs.io/en/latest/", None),
92     "myst-nb": ("https://myst-nb.readthedocs.io/en/stable/", None),
93     "ipywidgets": ("https://ipywidgets.readthedocs.io/en/stable/", None),
94     "jupytext": ("https://jupytext.readthedocs.io/en/stable/", None),
95     "ipyleaflet": ("https://ipyleaflet.readthedocs.io/en/latest/", None),
96     "poliastro": ("https://docs.poliastro.space/en/stable/", None),
97     "qiskit": ("https://qiskit.org/documentation/", None),
98     "myst-parser": ("https://myst-parser.readthedocs.io/en/stable/", None),
99     "writethedocs": ("https://www.writethedocs.org/", None),
100     "jupyterbook": ("https://jupyterbook.org/en/stable/", None),
101     "executablebook": ("https://executablebooks.org/en/latest/", None),
102     "rst-to-myst": ("https://rst-to-myst.readthedocs.io/en/stable/", None),
103     "rtd": ("https://docs.readthedocs.io/en/stable/", None),
104     "rtd-dev": ("https://dev.readthedocs.io/en/latest/", None),
105     "jupyter": ("https://docs.jupyter.org/en/latest/", None),
106 }
107 
108 # Intersphinx: Do not try to resolve unresolved labels that aren't explicitly prefixed.
109 # The default setting for intersphinx_disabled_reftypes can cause some pretty bad
110 # breakage because we have rtd and rtd-dev stable versions in our mappings.
111 # Hence, if we refactor labels, we won't see broken references, since the
112 # currently active stable mapping keeps resolving.
113 # Recommending doing this on all projects with Intersphinx.
114 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes
115 intersphinx_disabled_reftypes = ["*"]
116 
117 myst_enable_extensions = [
118     "deflist",
119 ]
120 hoverxref_intersphinx = [
121     "sphinx",
122     "pip",
123     "nbsphinx",
124     "myst-nb",
125     "ipywidgets",
126     "jupytext",
127 ]
128 htmlhelp_basename = "ReadTheDocsdoc"
129 latex_documents = [
130     (
131         "index",
132         "ReadTheDocs.tex",
133         "Read the Docs Documentation",
134         "Eric Holscher, Charlie Leifer, Bobby Grace",
135         "manual",
136     ),
137 ]
138 man_pages = [
139     (
140         "index",
141         "read-the-docs",
142         "Read the Docs Documentation",
143         ["Eric Holscher, Charlie Leifer, Bobby Grace"],
144         1,
145     )
146 ]
147 
148 language = "en"
149 
150 locale_dirs = [
151     f"{docset}/locale/",
152 ]
153 gettext_compact = False
154 
155 html_theme = "sphinx_rtd_theme"
156 html_static_path = ["_static", f"{docset}/_static"]
157 html_css_files = ["css/custom.css", "css/sphinx_prompt_css.css"]
158 html_js_files = ["js/expand_tabs.js"]
159 
160 if os.environ.get("READTHEDOCS_VERSION_TYPE") == "external":
161     html_js_files.append("js/readthedocs-doc-diff.js")
162 
163 html_logo = "img/logo.svg"
164 html_theme_options = {
165     "logo_only": True,
166     "display_version": False,
167 }
168 html_context = {
169     # Fix the "edit on" links.
170     # TODO: remove once we support different rtd config
171     # files per project.
172     "conf_py_path": f"/docs/{docset}/",
173     # Use to generate the Plausible "data-domain" attribute from the template
174     "plausible_domain": f"{os.environ.get('READTHEDOCS_PROJECT')}.readthedocs.io",
175 }
176 
177 hoverxref_auto_ref = True
178 hoverxref_domains = ["py"]
179 hoverxref_roles = [
180     "option",
181     # Documentation pages
182     # Not supported yet: https://github.com/readthedocs/sphinx-hoverxref/issues/18
183     "doc",
184     # Glossary terms
185     "term",
186 ]
187 hoverxref_role_types = {
188     "mod": "modal",  # for Python Sphinx Domain
189     "doc": "modal",  # for whole docs
190     "class": "tooltip",  # for Python Sphinx Domain
191     "ref": "tooltip",  # for hoverxref_auto_ref config
192     "confval": "tooltip",  # for custom object
193     "term": "tooltip",  # for glossaries
194 }
195 
196 # See dev/style_guide.rst for documentation
197 rst_epilog = """
198 .. |org_brand| replace:: Read the Docs Community
199 .. |com_brand| replace:: Read the Docs for Business
200 .. |git_providers_and| replace:: GitHub, Bitbucket, and GitLab
201 .. |git_providers_or| replace:: GitHub, Bitbucket, or GitLab
202 """
203 
204 # Activate autosectionlabel plugin
205 autosectionlabel_prefix_document = True
206 
207 # sphinx-notfound-page
208 # https://github.com/readthedocs/sphinx-notfound-page
209 notfound_context = {
210     "title": "Page Not Found",
211     "body": """
212 <h1>Page Not Found</h1>
213 
214 <p>Sorry, we couldn't find that page.</p>
215 
216 <p>Try using the search box or go to the homepage.</p>
217 """,
218 }
219 linkcheck_retries = 2
220 linkcheck_timeout = 1
221 linkcheck_workers = 10
222 linkcheck_ignore = [
223     r"http://127\.0\.0\.1",
224     r"http://localhost",
225     r"http://community\.dev\.readthedocs\.io",
226     r"https://yourproject\.readthedocs\.io",
227     r"https?://docs\.example\.com",
228     r"https://foo\.readthedocs\.io/projects",
229     r"https://github\.com.+?#L\d+",
230     r"https://github\.com/readthedocs/readthedocs\.org/issues",
231     r"https://github\.com/readthedocs/readthedocs\.org/pull",
232     r"https://docs\.readthedocs\.io/\?rtd_search",
233     r"https://readthedocs\.org/search",
234     # This page is under login
235     r"https://readthedocs\.org/accounts/gold",
236 ]
237 
238 extlinks = {
239     "rtd-issue": ("https://github.com/readthedocs/readthedocs.org/issues/%s", "#%s"),
240 }
241 
242 # Disable epub mimetype warnings
243 suppress_warnings = ["epub.unknown_project_files"]
244
```
--- 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
@@ -102,6 +102,7 @@
     "rst-to-myst": ("https://rst-to-myst.readthedocs.io/en/stable/", None),
     "rtd": ("https://docs.readthedocs.io/en/stable/", None),
     "rtd-dev": ("https://dev.readthedocs.io/en/latest/", None),
+    "rtd-blog": ("https://blog.readthedocs.com/", None),
     "jupyter": ("https://docs.jupyter.org/en/latest/", None),
 }

{"golden_diff": "diff --git a/docs/conf.py b/docs/conf.py\n--- a/docs/conf.py\n+++ b/docs/conf.py\n@@ -102,6 +102,7 @@\n     \"rst-to-myst\": (\"https://rst-to-myst.readthedocs.io/en/stable/\", None),\n     \"rtd\": (\"https://docs.readthedocs.io/en/stable/\", None),\n     \"rtd-dev\": (\"https://dev.readthedocs.io/en/latest/\", None),\n+    \"rtd-blog\": (\"https://blog.readthedocs.com/\", None),\n     \"jupyter\": (\"https://docs.jupyter.org/en/latest/\", None),\n }\n", "issue": "Docs: Config file deprecation warnings\n* [x] Upgrade v1 docs to clearly indicate that it's removed in September 2023 and link to the v2 version\r\n* [x] Add warning banners in various places\r\n\r\nReferences https://github.com/readthedocs/readthedocs.org/issues/10342\n", "before_files": [{"content": "\"\"\"\nShared Sphinx configuration using sphinx-multiproject.\n\nTo build each project, the ``PROJECT`` environment variable is used.\n\n.. code:: console\n\n   $ make html  # build default project\n   $ PROJECT=dev make html  # build the dev project\n\nfor more information read https://sphinx-multiproject.readthedocs.io/.\n\"\"\"\n\nimport os\nimport sys\n\nfrom multiproject.utils import get_project\n\nsys.path.append(os.path.abspath(\"_ext\"))\nextensions = [\n    \"hoverxref.extension\",\n    \"multiproject\",\n    \"myst_parser\",\n    \"notfound.extension\",\n    \"sphinx_design\",\n    \"sphinx_search.extension\",\n    \"sphinx_tabs.tabs\",\n    \"sphinx-prompt\",\n    \"sphinx.ext.autodoc\",\n    \"sphinx.ext.autosectionlabel\",\n    \"sphinx.ext.extlinks\",\n    \"sphinx.ext.intersphinx\",\n    \"sphinxcontrib.httpdomain\",\n    \"sphinxcontrib.video\",\n    \"sphinxemoji.sphinxemoji\",\n    \"sphinxext.opengraph\",\n]\n\nmultiproject_projects = {\n    \"user\": {\n        \"use_config_file\": False,\n        \"config\": {\n            \"project\": \"Read the Docs user documentation\",\n        },\n    },\n    \"dev\": {\n        \"use_config_file\": False,\n        \"config\": {\n            \"project\": \"Read the Docs developer documentation\",\n        },\n    },\n}\n\ndocset = get_project(multiproject_projects)\n\nogp_site_name = \"Read the Docs Documentation\"\nogp_use_first_image = True  # https://github.com/readthedocs/blog/pull/118\nogp_image = \"https://docs.readthedocs.io/en/latest/_static/img/logo-opengraph.png\"\n# Inspired by https://github.com/executablebooks/MyST-Parser/pull/404/\nogp_custom_meta_tags = [\n    '<meta name=\"twitter:card\" content=\"summary_large_image\" />',\n]\nogp_enable_meta_description = True\nogp_description_length = 300\n\ntemplates_path = [\"_templates\"]\n\n# This may be elevated as a general issue for documentation and behavioral\n# change to the Sphinx build:\n# This will ensure that we use the correctly set environment for canonical URLs\n# Old Read the Docs injections makes it point only to the default version,\n# for instance /en/stable/\nhtml_baseurl = os.environ.get(\"READTHEDOCS_CANONICAL_URL\", \"/\")\n\nmaster_doc = \"index\"\ncopyright = \"Read the Docs, Inc & contributors\"\nversion = \"9.13.2\"\nrelease = version\nexclude_patterns = [\"_build\", \"shared\", \"_includes\"]\ndefault_role = \"obj\"\nintersphinx_cache_limit = 14  # cache for 2 weeks\nintersphinx_timeout = 3  # 3 seconds timeout\nintersphinx_mapping = {\n    \"python\": (\"https://docs.python.org/3.10/\", None),\n    \"django\": (\n        \"https://docs.djangoproject.com/en/stable/\",\n        \"https://docs.djangoproject.com/en/stable/_objects/\",\n    ),\n    \"sphinx\": (\"https://www.sphinx-doc.org/en/master/\", None),\n    \"pip\": (\"https://pip.pypa.io/en/stable/\", None),\n    \"nbsphinx\": (\"https://nbsphinx.readthedocs.io/en/latest/\", None),\n    \"myst-nb\": (\"https://myst-nb.readthedocs.io/en/stable/\", None),\n    \"ipywidgets\": (\"https://ipywidgets.readthedocs.io/en/stable/\", None),\n    \"jupytext\": (\"https://jupytext.readthedocs.io/en/stable/\", None),\n    \"ipyleaflet\": (\"https://ipyleaflet.readthedocs.io/en/latest/\", None),\n    \"poliastro\": (\"https://docs.poliastro.space/en/stable/\", None),\n    \"qiskit\": (\"https://qiskit.org/documentation/\", None),\n    \"myst-parser\": (\"https://myst-parser.readthedocs.io/en/stable/\", None),\n    \"writethedocs\": (\"https://www.writethedocs.org/\", None),\n    \"jupyterbook\": (\"https://jupyterbook.org/en/stable/\", None),\n    \"executablebook\": (\"https://executablebooks.org/en/latest/\", None),\n    \"rst-to-myst\": (\"https://rst-to-myst.readthedocs.io/en/stable/\", None),\n    \"rtd\": (\"https://docs.readthedocs.io/en/stable/\", None),\n    \"rtd-dev\": (\"https://dev.readthedocs.io/en/latest/\", None),\n    \"jupyter\": (\"https://docs.jupyter.org/en/latest/\", None),\n}\n\n# Intersphinx: Do not try to resolve unresolved labels that aren't explicitly prefixed.\n# The default setting for intersphinx_disabled_reftypes can cause some pretty bad\n# breakage because we have rtd and rtd-dev stable versions in our mappings.\n# Hence, if we refactor labels, we won't see broken references, since the\n# currently active stable mapping keeps resolving.\n# Recommending doing this on all projects with Intersphinx.\n# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes\nintersphinx_disabled_reftypes = [\"*\"]\n\nmyst_enable_extensions = [\n    \"deflist\",\n]\nhoverxref_intersphinx = [\n    \"sphinx\",\n    \"pip\",\n    \"nbsphinx\",\n    \"myst-nb\",\n    \"ipywidgets\",\n    \"jupytext\",\n]\nhtmlhelp_basename = \"ReadTheDocsdoc\"\nlatex_documents = [\n    (\n        \"index\",\n        \"ReadTheDocs.tex\",\n        \"Read the Docs Documentation\",\n        \"Eric Holscher, Charlie Leifer, Bobby Grace\",\n        \"manual\",\n    ),\n]\nman_pages = [\n    (\n        \"index\",\n        \"read-the-docs\",\n        \"Read the Docs Documentation\",\n        [\"Eric Holscher, Charlie Leifer, Bobby Grace\"],\n        1,\n    )\n]\n\nlanguage = \"en\"\n\nlocale_dirs = [\n    f\"{docset}/locale/\",\n]\ngettext_compact = False\n\nhtml_theme = \"sphinx_rtd_theme\"\nhtml_static_path = [\"_static\", f\"{docset}/_static\"]\nhtml_css_files = [\"css/custom.css\", \"css/sphinx_prompt_css.css\"]\nhtml_js_files = [\"js/expand_tabs.js\"]\n\nif os.environ.get(\"READTHEDOCS_VERSION_TYPE\") == \"external\":\n    html_js_files.append(\"js/readthedocs-doc-diff.js\")\n\nhtml_logo = \"img/logo.svg\"\nhtml_theme_options = {\n    \"logo_only\": True,\n    \"display_version\": False,\n}\nhtml_context = {\n    # Fix the \"edit on\" links.\n    # TODO: remove once we support different rtd config\n    # files per project.\n    \"conf_py_path\": f\"/docs/{docset}/\",\n    # Use to generate the Plausible \"data-domain\" attribute from the template\n    \"plausible_domain\": f\"{os.environ.get('READTHEDOCS_PROJECT')}.readthedocs.io\",\n}\n\nhoverxref_auto_ref = True\nhoverxref_domains = [\"py\"]\nhoverxref_roles = [\n    \"option\",\n    # Documentation pages\n    # Not supported yet: https://github.com/readthedocs/sphinx-hoverxref/issues/18\n    \"doc\",\n    # Glossary terms\n    \"term\",\n]\nhoverxref_role_types = {\n    \"mod\": \"modal\",  # for Python Sphinx Domain\n    \"doc\": \"modal\",  # for whole docs\n    \"class\": \"tooltip\",  # for Python Sphinx Domain\n    \"ref\": \"tooltip\",  # for hoverxref_auto_ref config\n    \"confval\": \"tooltip\",  # for custom object\n    \"term\": \"tooltip\",  # for glossaries\n}\n\n# See dev/style_guide.rst for documentation\nrst_epilog = \"\"\"\n.. |org_brand| replace:: Read the Docs Community\n.. |com_brand| replace:: Read the Docs for Business\n.. |git_providers_and| replace:: GitHub, Bitbucket, and GitLab\n.. |git_providers_or| replace:: GitHub, Bitbucket, or GitLab\n\"\"\"\n\n# Activate autosectionlabel plugin\nautosectionlabel_prefix_document = True\n\n# sphinx-notfound-page\n# https://github.com/readthedocs/sphinx-notfound-page\nnotfound_context = {\n    \"title\": \"Page Not Found\",\n    \"body\": \"\"\"\n<h1>Page Not Found</h1>\n\n<p>Sorry, we couldn't find that page.</p>\n\n<p>Try using the search box or go to the homepage.</p>\n\"\"\",\n}\nlinkcheck_retries = 2\nlinkcheck_timeout = 1\nlinkcheck_workers = 10\nlinkcheck_ignore = [\n    r\"http://127\\.0\\.0\\.1\",\n    r\"http://localhost\",\n    r\"http://community\\.dev\\.readthedocs\\.io\",\n    r\"https://yourproject\\.readthedocs\\.io\",\n    r\"https?://docs\\.example\\.com\",\n    r\"https://foo\\.readthedocs\\.io/projects\",\n    r\"https://github\\.com.+?#L\\d+\",\n    r\"https://github\\.com/readthedocs/readthedocs\\.org/issues\",\n    r\"https://github\\.com/readthedocs/readthedocs\\.org/pull\",\n    r\"https://docs\\.readthedocs\\.io/\\?rtd_search\",\n    r\"https://readthedocs\\.org/search\",\n    # This page is under login\n    r\"https://readthedocs\\.org/accounts/gold\",\n]\n\nextlinks = {\n    \"rtd-issue\": (\"https://github.com/readthedocs/readthedocs.org/issues/%s\", \"#%s\"),\n}\n\n# Disable epub mimetype warnings\nsuppress_warnings = [\"epub.unknown_project_files\"]\n", "path": "docs/conf.py"}], "after_files": [{"content": "\"\"\"\nShared Sphinx configuration using sphinx-multiproject.\n\nTo build each project, the ``PROJECT`` environment variable is used.\n\n.. code:: console\n\n   $ make html  # build default project\n   $ PROJECT=dev make html  # build the dev project\n\nfor more information read https://sphinx-multiproject.readthedocs.io/.\n\"\"\"\n\nimport os\nimport sys\n\nfrom multiproject.utils import get_project\n\nsys.path.append(os.path.abspath(\"_ext\"))\nextensions = [\n    \"hoverxref.extension\",\n    \"multiproject\",\n    \"myst_parser\",\n    \"notfound.extension\",\n    \"sphinx_design\",\n    \"sphinx_search.extension\",\n    \"sphinx_tabs.tabs\",\n    \"sphinx-prompt\",\n    \"sphinx.ext.autodoc\",\n    \"sphinx.ext.autosectionlabel\",\n    \"sphinx.ext.extlinks\",\n    \"sphinx.ext.intersphinx\",\n    \"sphinxcontrib.httpdomain\",\n    \"sphinxcontrib.video\",\n    \"sphinxemoji.sphinxemoji\",\n    \"sphinxext.opengraph\",\n]\n\nmultiproject_projects = {\n    \"user\": {\n        \"use_config_file\": False,\n        \"config\": {\n            \"project\": \"Read the Docs user documentation\",\n        },\n    },\n    \"dev\": {\n        \"use_config_file\": False,\n        \"config\": {\n            \"project\": \"Read the Docs developer documentation\",\n        },\n    },\n}\n\ndocset = get_project(multiproject_projects)\n\nogp_site_name = \"Read the Docs Documentation\"\nogp_use_first_image = True  # https://github.com/readthedocs/blog/pull/118\nogp_image = \"https://docs.readthedocs.io/en/latest/_static/img/logo-opengraph.png\"\n# Inspired by https://github.com/executablebooks/MyST-Parser/pull/404/\nogp_custom_meta_tags = [\n    '<meta name=\"twitter:card\" content=\"summary_large_image\" />',\n]\nogp_enable_meta_description = True\nogp_description_length = 300\n\ntemplates_path = [\"_templates\"]\n\n# This may be elevated as a general issue for documentation and behavioral\n# change to the Sphinx build:\n# This will ensure that we use the correctly set environment for canonical URLs\n# Old Read the Docs injections makes it point only to the default version,\n# for instance /en/stable/\nhtml_baseurl = os.environ.get(\"READTHEDOCS_CANONICAL_URL\", \"/\")\n\nmaster_doc = \"index\"\ncopyright = \"Read the Docs, Inc & contributors\"\nversion = \"9.13.2\"\nrelease = version\nexclude_patterns = [\"_build\", \"shared\", \"_includes\"]\ndefault_role = \"obj\"\nintersphinx_cache_limit = 14  # cache for 2 weeks\nintersphinx_timeout = 3  # 3 seconds timeout\nintersphinx_mapping = {\n    \"python\": (\"https://docs.python.org/3.10/\", None),\n    \"django\": (\n        \"https://docs.djangoproject.com/en/stable/\",\n        \"https://docs.djangoproject.com/en/stable/_objects/\",\n    ),\n    \"sphinx\": (\"https://www.sphinx-doc.org/en/master/\", None),\n    \"pip\": (\"https://pip.pypa.io/en/stable/\", None),\n    \"nbsphinx\": (\"https://nbsphinx.readthedocs.io/en/latest/\", None),\n    \"myst-nb\": (\"https://myst-nb.readthedocs.io/en/stable/\", None),\n    \"ipywidgets\": (\"https://ipywidgets.readthedocs.io/en/stable/\", None),\n    \"jupytext\": (\"https://jupytext.readthedocs.io/en/stable/\", None),\n    \"ipyleaflet\": (\"https://ipyleaflet.readthedocs.io/en/latest/\", None),\n    \"poliastro\": (\"https://docs.poliastro.space/en/stable/\", None),\n    \"qiskit\": (\"https://qiskit.org/documentation/\", None),\n    \"myst-parser\": (\"https://myst-parser.readthedocs.io/en/stable/\", None),\n    \"writethedocs\": (\"https://www.writethedocs.org/\", None),\n    \"jupyterbook\": (\"https://jupyterbook.org/en/stable/\", None),\n    \"executablebook\": (\"https://executablebooks.org/en/latest/\", None),\n    \"rst-to-myst\": (\"https://rst-to-myst.readthedocs.io/en/stable/\", None),\n    \"rtd\": (\"https://docs.readthedocs.io/en/stable/\", None),\n    \"rtd-dev\": (\"https://dev.readthedocs.io/en/latest/\", None),\n    \"rtd-blog\": (\"https://blog.readthedocs.com/\", None),\n    \"jupyter\": (\"https://docs.jupyter.org/en/latest/\", None),\n}\n\n# Intersphinx: Do not try to resolve unresolved labels that aren't explicitly prefixed.\n# The default setting for intersphinx_disabled_reftypes can cause some pretty bad\n# breakage because we have rtd and rtd-dev stable versions in our mappings.\n# Hence, if we refactor labels, we won't see broken references, since the\n# currently active stable mapping keeps resolving.\n# Recommending doing this on all projects with Intersphinx.\n# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes\nintersphinx_disabled_reftypes = [\"*\"]\n\nmyst_enable_extensions = [\n    \"deflist\",\n]\nhoverxref_intersphinx = [\n    \"sphinx\",\n    \"pip\",\n    \"nbsphinx\",\n    \"myst-nb\",\n    \"ipywidgets\",\n    \"jupytext\",\n]\nhtmlhelp_basename = \"ReadTheDocsdoc\"\nlatex_documents = [\n    (\n        \"index\",\n        \"ReadTheDocs.tex\",\n        \"Read the Docs Documentation\",\n        \"Eric Holscher, Charlie Leifer, Bobby Grace\",\n        \"manual\",\n    ),\n]\nman_pages = [\n    (\n        \"index\",\n        \"read-the-docs\",\n        \"Read the Docs Documentation\",\n        [\"Eric Holscher, Charlie Leifer, Bobby Grace\"],\n        1,\n    )\n]\n\nlanguage = \"en\"\n\nlocale_dirs = [\n    f\"{docset}/locale/\",\n]\ngettext_compact = False\n\nhtml_theme = \"sphinx_rtd_theme\"\nhtml_static_path = [\"_static\", f\"{docset}/_static\"]\nhtml_css_files = [\"css/custom.css\", \"css/sphinx_prompt_css.css\"]\nhtml_js_files = [\"js/expand_tabs.js\"]\n\nif os.environ.get(\"READTHEDOCS_VERSION_TYPE\") == \"external\":\n    html_js_files.append(\"js/readthedocs-doc-diff.js\")\n\nhtml_logo = \"img/logo.svg\"\nhtml_theme_options = {\n    \"logo_only\": True,\n    \"display_version\": False,\n}\nhtml_context = {\n    # Fix the \"edit on\" links.\n    # TODO: remove once we support different rtd config\n    # files per project.\n    \"conf_py_path\": f\"/docs/{docset}/\",\n    # Use to generate the Plausible \"data-domain\" attribute from the template\n    \"plausible_domain\": f\"{os.environ.get('READTHEDOCS_PROJECT')}.readthedocs.io\",\n}\n\nhoverxref_auto_ref = True\nhoverxref_domains = [\"py\"]\nhoverxref_roles = [\n    \"option\",\n    # Documentation pages\n    # Not supported yet: https://github.com/readthedocs/sphinx-hoverxref/issues/18\n    \"doc\",\n    # Glossary terms\n    \"term\",\n]\nhoverxref_role_types = {\n    \"mod\": \"modal\",  # for Python Sphinx Domain\n    \"doc\": \"modal\",  # for whole docs\n    \"class\": \"tooltip\",  # for Python Sphinx Domain\n    \"ref\": \"tooltip\",  # for hoverxref_auto_ref config\n    \"confval\": \"tooltip\",  # for custom object\n    \"term\": \"tooltip\",  # for glossaries\n}\n\n# See dev/style_guide.rst for documentation\nrst_epilog = \"\"\"\n.. |org_brand| replace:: Read the Docs Community\n.. |com_brand| replace:: Read the Docs for Business\n.. |git_providers_and| replace:: GitHub, Bitbucket, and GitLab\n.. |git_providers_or| replace:: GitHub, Bitbucket, or GitLab\n\"\"\"\n\n# Activate autosectionlabel plugin\nautosectionlabel_prefix_document = True\n\n# sphinx-notfound-page\n# https://github.com/readthedocs/sphinx-notfound-page\nnotfound_context = {\n    \"title\": \"Page Not Found\",\n    \"body\": \"\"\"\n<h1>Page Not Found</h1>\n\n<p>Sorry, we couldn't find that page.</p>\n\n<p>Try using the search box or go to the homepage.</p>\n\"\"\",\n}\nlinkcheck_retries = 2\nlinkcheck_timeout = 1\nlinkcheck_workers = 10\nlinkcheck_ignore = [\n    r\"http://127\\.0\\.0\\.1\",\n    r\"http://localhost\",\n    r\"http://community\\.dev\\.readthedocs\\.io\",\n    r\"https://yourproject\\.readthedocs\\.io\",\n    r\"https?://docs\\.example\\.com\",\n    r\"https://foo\\.readthedocs\\.io/projects\",\n    r\"https://github\\.com.+?#L\\d+\",\n    r\"https://github\\.com/readthedocs/readthedocs\\.org/issues\",\n    r\"https://github\\.com/readthedocs/readthedocs\\.org/pull\",\n    r\"https://docs\\.readthedocs\\.io/\\?rtd_search\",\n    r\"https://readthedocs\\.org/search\",\n    # This page is under login\n    r\"https://readthedocs\\.org/accounts/gold\",\n]\n\nextlinks = {\n    \"rtd-issue\": (\"https://github.com/readthedocs/readthedocs.org/issues/%s\", \"#%s\"),\n}\n\n# Disable epub mimetype warnings\nsuppress_warnings = [\"epub.unknown_project_files\"]\n", "path": "docs/conf.py"}]}