DOCS: try to move conf.py one level up.

docs/Makefile

@@ -12,7 +12,7 @@ PYTHON        = python3
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
+ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck api
 

docs/source/conf.py → docs/conf.py

@@ -19,10 +19,10 @@
 from pathlib import Path
 
 # https://read-the-docs.readthedocs.io/en/latest/faq.html
-ON_RTD = os.environ.get('READTHEDOCS', None) == 'True'
+ON_RTD = os.environ.get("READTHEDOCS", None) == "True"
 
 if ON_RTD:
-    tags.add('rtd')
+    tags.add("rtd")
 
     # RTD doesn't use the Makefile, so re-run autogen_{things}.py here.
     for name in ("config", "api", "magics", "shortcuts"):
@@ -52,14 +52,14 @@
 # If your extensions are in another directory, add it here. If the directory
 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../sphinxext'))
+sys.path.insert(0, os.path.abspath("sphinxext"))
 
 # We load the ipython release info into a dict by explicit execution
 iprelease = {}
 exec(
     compile(
-        open("../../IPython/core/release.py", encoding="utf-8").read(),
-        "../../IPython/core/release.py",
+        open("../IPython/core/release.py", encoding="utf-8").read(),
+        "../IPython/core/release.py",
         "exec",
     ),
     iprelease,
@@ -87,25 +87,27 @@
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["source/_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
+
+rst_prolog = ""
 
-rst_prolog = ''
 
 def is_stable(extra):
-    for ext in {'dev', 'b', 'rc'}:
+    for ext in {"dev", "b", "rc"}:
         if ext in extra:
             return False
     return True
 
-if is_stable(iprelease['_version_extra']):
-    tags.add('ipystable')
-    print('Adding Tag: ipystable')
+
+if is_stable(iprelease["_version_extra"]):
+    tags.add("ipystable")
+    print("Adding Tag: ipystable")
 else:
-    tags.add('ipydev')
-    print('Adding Tag: ipydev')
+    tags.add("ipydev")
+    print("Adding Tag: ipydev")
     rst_prolog += """
 .. warning::
 
@@ -127,22 +129,23 @@ def is_stable(extra):
 """
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General substitutions.
-project = 'IPython'
-copyright = 'The IPython Development Team'
+project = "IPython"
+copyright = "The IPython Development Team"
 
 # ghissue config
 github_project_url = "https://github.com/ipython/ipython"
 
 # numpydoc config
-numpydoc_show_class_members = False # Otherwise Sphinx emits thousands of warnings
+numpydoc_show_class_members = False  # Otherwise Sphinx emits thousands of warnings
 numpydoc_class_members_toctree = False
 warning_is_error = True
 
 import logging
 
+
 class ConfigtraitFilter(logging.Filter):
     """
     This is a filter to remove in sphinx 3+ the error about config traits being duplicated.
@@ -153,55 +156,61 @@ class ConfigtraitFilter(logging.Filter):
     """
 
     def filter(self, record):
-        if record.args and record.args[0] == 'configtrait' and 'duplicate' in record.msg:
+        if (
+            record.args
+            and record.args[0] == "configtrait"
+            and "duplicate" in record.msg
+        ):
             return False
         return True
 
+
 ct_filter = ConfigtraitFilter()
 
 import sphinx.util
-logger = sphinx.util.logging.getLogger('sphinx.domains.std').logger
+
+logger = sphinx.util.logging.getLogger("sphinx.domains.std").logger
 
 logger.addFilter(ct_filter)
 
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = "%s" % iprelease['version']
+release = "%s" % iprelease["version"]
 # Just the X.Y.Z part, no '-dev'
-version = iprelease['version'].split('-', 1)[0]
+version = iprelease["version"].split("-", 1)[0]
 
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-today_fmt = '%B %d, %Y'
+today_fmt = "%B %d, %Y"
 
 # List of documents that shouldn't be included in the build.
-#unused_docs = []
+# unused_docs = []
 
 # Exclude these glob-style patterns when looking for source files. They are
 # relative to the source/ directory.
 exclude_patterns = ["**.ipynb_checkpoints"]
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # Set the default role so we can use `foo` instead of ``foo``
-default_role = 'literal'
+default_role = "literal"
 
 # Options for HTML output
 # -----------------------
@@ -213,99 +222,111 @@ def filter(self, record):
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # The name of an image file (within the static path) to place at the top of
 # the sidebar.
-#html_logo = None
+# html_logo = None
 
 # 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']
+html_static_path = ["source/_static"]
 
 # Favicon needs the directory name
-html_favicon = '_static/favicon.ico'
+html_favicon = "_static/favicon.ico"
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = "%b %d, %Y"
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 html_additional_pages = {
-    'interactive/htmlnotebook': 'notebook_redirect.html',
-    'interactive/notebook': 'notebook_redirect.html',
-    'interactive/nbconvert': 'notebook_redirect.html',
-    'interactive/public_server': 'notebook_redirect.html',
+    "source/interactive/htmlnotebook": "notebook_redirect.html",
+    "source/interactive/notebook": "notebook_redirect.html",
+    "source/interactive/nbconvert": "notebook_redirect.html",
+    "source/interactive/public_server": "notebook_redirect.html",
 }
 
 # If false, no module index is generated.
-#html_use_modindex = True
+# html_use_modindex = True
 
 # If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
+# html_copy_source = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+# html_file_suffix = ''
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'ipythondoc'
-
-intersphinx_mapping = {'python': ('https://docs.python.org/3/', None),
-                       'rpy2': ('https://rpy2.github.io/doc/latest/html/', None),
-                       'jupyterclient': ('https://jupyter-client.readthedocs.io/en/latest/', None),
-                       'jupyter': ('https://jupyter.readthedocs.io/en/latest/', None),
-                       'jedi': ('https://jedi.readthedocs.io/en/latest/', None),
-                       'traitlets': ('https://traitlets.readthedocs.io/en/latest/', None),
-                       'ipykernel': ('https://ipykernel.readthedocs.io/en/latest/', None),
-                       'prompt_toolkit' : ('https://python-prompt-toolkit.readthedocs.io/en/stable/', None),
-                       'ipywidgets': ('https://ipywidgets.readthedocs.io/en/stable/', None),
-                       'ipyparallel': ('https://ipyparallel.readthedocs.io/en/stable/', None),
-                       'pip': ('https://pip.pypa.io/en/stable/', None)
-                      }
+htmlhelp_basename = "ipythondoc"
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "rpy2": ("https://rpy2.github.io/doc/latest/html/", None),
+    "jupyterclient": ("https://jupyter-client.readthedocs.io/en/latest/", None),
+    "jupyter": ("https://jupyter.readthedocs.io/en/latest/", None),
+    "jedi": ("https://jedi.readthedocs.io/en/latest/", None),
+    "traitlets": ("https://traitlets.readthedocs.io/en/latest/", None),
+    "ipykernel": ("https://ipykernel.readthedocs.io/en/latest/", None),
+    "prompt_toolkit": ("https://python-prompt-toolkit.readthedocs.io/en/stable/", None),
+    "ipywidgets": ("https://ipywidgets.readthedocs.io/en/stable/", None),
+    "ipyparallel": ("https://ipyparallel.readthedocs.io/en/stable/", None),
+    "pip": ("https://pip.pypa.io/en/stable/", None),
+}
 
 # Options for LaTeX output
 # ------------------------
 
 # The font size ('10pt', '11pt' or '12pt').
-latex_font_size = '11pt'
+latex_font_size = "11pt"
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
 
 latex_documents = [
-    ('index', 'ipython.tex', 'IPython Documentation',
-     u"""The IPython Development Team""", 'manual', True),
-    ('parallel/winhpc_index', 'winhpc_whitepaper.tex',
-     'Using IPython on Windows HPC Server 2008',
-     u"Brian E. Granger", 'manual', True)
+    (
+        "index",
+        "ipython.tex",
+        "IPython Documentation",
+        """The IPython Development Team""",
+        "manual",
+        True,
+    ),
+    (
+        "parallel/winhpc_index",
+        "winhpc_whitepaper.tex",
+        "Using IPython on Windows HPC Server 2008",
+        "Brian E. Granger",
+        "manual",
+        True,
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
 latex_use_modindex = True
@@ -315,15 +336,19 @@ def filter(self, record):
 # --------------------------
 
 texinfo_documents = [
-  (master_doc, 'ipython', 'IPython Documentation',
-   'The IPython Development Team',
-   'IPython',
-   'IPython Documentation',
-   'Programming',
-   1),
+    (
+        master_doc,
+        "ipython",
+        "IPython Documentation",
+        "The IPython Development Team",
+        "IPython",
+        "IPython Documentation",
+        "Programming",
+        1,
+    ),
 ]
 
-modindex_common_prefix = ['IPython.']
+modindex_common_prefix = ["IPython."]
 
 
 def setup(app):