CheckExternalLinsBuilder has no attributer highlighter - am I doing it wrong?

[waynew]

I'm not sure if I've got something misconfigured - and it's super weird because this works totally fine in another repo, but I'm seeing this error:

Traceback (most recent call last):
  File "/home/wayne/programming/delete-me/.nox/docs/lib/python3.9/site-packages/sphinx/events.py", line 101, in emit
    results.append(listener.handler(self.app, *args))
  File "/home/wayne/programming/delete-me/.nox/docs/lib/python3.9/site-packages/furo/__init__.py", line 214, in _builder_inited
    update_known_styles_state(app)
  File "/home/wayne/programming/delete-me/.nox/docs/lib/python3.9/site-packages/furo/__init__.py", line 222, in update_known_styles_state
    "light": _get_light_style(app),
  File "/home/wayne/programming/delete-me/.nox/docs/lib/python3.9/site-packages/furo/__init__.py", line 228, in _get_light_style
    return app.builder.highlighter.formatter_args["style"]
AttributeError: 'CheckExternalLinksBuilder' object has no attribute 'highlighter'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/wayne/programming/delete-me/.nox/docs/lib/python3.9/site-packages/sphinx/cmd/build.py", line 276, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/home/wayne/programming/delete-me/.nox/docs/lib/python3.9/site-packages/sphinx/application.py", line 270, in __init__
    self._init_builder()
  File "/home/wayne/programming/delete-me/.nox/docs/lib/python3.9/site-packages/sphinx/application.py", line 328, in _init_builder
    self.events.emit('builder-inited')
  File "/home/wayne/programming/delete-me/.nox/docs/lib/python3.9/site-packages/sphinx/events.py", line 109, in emit
    raise ExtensionError(__("Handler %r for event %r threw an exception") %
sphinx.errors.ExtensionError: Handler <function _builder_inited at 0x7fd3f820e310> for event 'builder-inited' threw an exception (exception: 'CheckExternalLinksBuilder' object has no attribute 'highlighter')

Extension error (furo):
Handler <function _builder_inited at 0x7fd3f820e310> for event 'builder-inited' threw an exception (exception: 'CheckExternalLinksBuilder' object has no attribute 'highlighter')

And I'm not sure why. Here's my pip freeze:

alabaster==0.7.12
Babel==2.9.1
beautifulsoup4==4.9.1
certifi==2020.12.5
chardet==4.0.0
charset-normalizer==2.0.7
contextvars==2.4
css-html-js-minify==2.5.5
distro==1.5.0
docutils==0.16
furo==2021.9.22
idna==2.10
imagesize==1.2.0
immutables==0.16
Jinja2==3.0.0
lxml==4.5.2
MarkupSafe==2.0.0
msgpack==1.0.2
packaging==20.9
psutil==5.8.0
pycryptodomex==3.10.1
pyenchant==3.2.0
Pygments==2.9.0
pyparsing==2.4.7
python-slugify==4.0.1
pytz==2021.1
pyvmomi==7.0.2
PyYAML==5.4.1
pyzmq==22.0.3
requests==2.25.1
salt==3003
six==1.16.0
snowballstemmer==2.1.0
soupsieve==2.2.1
Sphinx==4.2.0
sphinx-copybutton==0.4.0
sphinx-material-saltstack==1.0.5
sphinx-prompt==1.4.0
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
sphinxcontrib-spelling==7.2.1
text-unidecode==1.3
Unidecode==1.2.0
urllib3==1.26.4

I'm not sure if this is just an "I've got the wrong version/config" or what.

[pradyunsg]

A few diagnostic questions:

• What version of Sphinx and Furo?
• What Sphinx command are you running?
• What are the contents of your conf.py?

[waynew]

From the freeze:

Sphinx==4.2.0
furo==2021.9.22 # I tried with every non-pre release version going back to the first pre-release version listed on pypi, same experience)

make linkcheck SPHINXOPTS=-W is the command I'm running

conf.py contents:

# 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 datetime
import os
import sys

try:
    from importlib_metadata import distribution
except ImportError:
    from importlib.metadata import distribution


try:
    docs_basepath = os.path.abspath(os.path.dirname(__file__))
except NameError:
    # sphinx-intl and six execute some code which will raise this NameError
    # assume we're in the doc/ directory
    docs_basepath = os.path.abspath(os.path.dirname("."))

addtl_paths = (
    os.path.join(os.pardir, "src"),  # saltext.ttp itself (for autodoc)
    "_ext",  # custom Sphinx extensions
)

for addtl_path in addtl_paths:
    sys.path.insert(0, os.path.abspath(os.path.join(docs_basepath, addtl_path)))

dist = distribution("saltext.buhleted")


# -- Project information -----------------------------------------------------
this_year = datetime.datetime.today().year
if this_year == 2021:
    copyright_year = 2021
else:
    copyright_year = f"2021 - {this_year}"
project = dist.metadata["Summary"]
author = dist.metadata["Author"]
copyright = f"{copyright_year}, {author}"

# The full version, including alpha/beta/rc tags
release = dist.version


# Variables to pass into the docs from sitevars.rst for rst substitution
with open("sitevars.rst") as site_vars_file:
    site_vars = site_vars_file.read().splitlines()

rst_prolog = """
{}
""".format(
    "\n".join(site_vars[:])
)

# -- 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 = [
    "furo",
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.napoleon",
    "sphinx.ext.intersphinx",
    "sphinx.ext.viewcode",
    "sphinx.ext.todo",
    "sphinx.ext.coverage",
    "sphinx_copybutton",
    "sphinxcontrib.spelling",
]

# 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",
    ".vscode",
    ".venv",
    ".git",
    ".gitlab-ci",
    ".gitignore",
    "sitevars.rst",
]

autosummary_generate = True

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = "furo"
html_title = project

# 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"]

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = ""

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large. Favicons can be up to at least 228x228. PNG
# format is supported as well, not just .ico'
html_favicon = ""

# Sphinx Napoleon Config
napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True

# ----- Intersphinx Config ---------------------------------------------------------------------------------------->
intersphinx_mapping = {
    "python": ("https://docs.python.org/3", None),
    "pytest": ("https://pytest.readthedocs.io/en/stable", None),
    "salt": ("https://docs.saltproject.io/en/latest", None),
}
# <---- Intersphinx Config -----------------------------------------------------------------------------------------

# ----- Autodoc Config ---------------------------------------------------------------------------------------------->
autodoc_default_options = {"member-order": "bysource"}
autodoc_mock_imports = ["salt"]
# <---- Autodoc Config -----------------------------------------------------------------------------------------------


def setup(app):
    app.add_crossref_type(
        directivename="fixture",
        rolename="fixture",
        indextemplate="pair: %s; fixture",
    )
    # Allow linking to pytest's confvals.
    app.add_object_type(
        "confval",
        "pytest-confval",
        objname="configuration value",
        indextemplate="pair: %s; configuration value",
    )

[pradyunsg]

Don’t add Furo as an extension.

It isn’t supposed to be specified anywhere other than in the html_theme variable.

[waynew]

That did it, thanks!