"is not using furo.css as the stylesheet" but not using html_style
#708
-
|
I get the following error when I try to build the docs, and I only started getting this error after doing a This documentation is not using `furo.css` as the stylesheet. If you have set `html_style` in your conf.py file, remove it.But I don't have ['_static/pygments.css', '_static/styles/furo.css?digest=369552022d0b975c8e74270ce6eabe0fb7978f24', '_static/graphviz.css', '_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e']
Here is my # 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/main/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 os
from datetime import date
# import sys
# sys.path.insert(0, os.path.abspath('../../'))
# -- Project information -----------------------------------------------------
project = "[redacted]"
copyright = f"{date.today().year}, [redacted]"
author = (
[redacted]
)
# The full version, including alpha/beta/rc tags
if os.environ.get("CI_COMMIT_TAG"):
release = os.environ["CI_COMMIT_TAG"]
else:
release = "latest"
# -- 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 = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"autoapi.extension",
"myst_parser",
"sphinx.ext.intersphinx",
]
intersphinx_mapping = {
"python": ("https://docs.python.org/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"scikit-image": ("https://scikit-image.org/docs/stable/", None),
"matplotlib": ("https://matplotlib.org/stable/", None),
"PIL": ("https://pillow.readthedocs.io/en/stable/", None),
}
tls_verify = False
# Autodoc settings
autodoc_typehints = "description"
# Autoapi settings
autoapi_options = ["members", "undoc-members", "show-inheritance", "show-module-summary"]
autoapi_python_class_content = "both"
autoapi_type = "python"
autoapi_dirs = ["../../[redacted]/"]
# 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 = ["**/_tests"]
# -- 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_logo = "../../assets/icons/[redacted]_logo.png"
# 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"] # this doesn't have any .css files only a single PNG
# If I comment out this ^ line, it gives me the same error
# favicon location
html_favicon = "../../assets/icons/favicon.ico"Here is my And here is the output from ❯ poetry show
aiohttp 3.8.5 Async http client/server framework (asyncio)
aiosignal 1.3.1 aiosignal: a list of registered asynchronous callbacks
alabaster 0.7.13 A configurable sidebar-enabled Sphinx theme
astroid 2.15.6 An abstract syntax tree for Python with inference support.
async-timeout 4.0.3 Timeout context manager for asyncio programs
attrs 23.1.0 Classes Without Boilerplate
babel 2.12.1 Internationalization utilities
bandit 1.7.5 Security oriented static analyser for python code.
beautifulsoup4 4.12.2 Screen-scraping library
black 23.7.0 The uncompromising code formatter.
certifi 2023.7.22 Python package for providing Mozilla's CA Bundle.
cfgv 3.4.0 Validate configuration and produce human readable error messages.
charset-normalizer 3.2.0 The Real First Universal Charset Detector. Open, modern and actively mainta...
click 8.1.7 Composable command line interface toolkit
coverage 7.3.0 Code coverage measurement for Python
dataclasses-json 0.5.9 Easily serialize dataclasses to and from JSON
distlib 0.3.7 Distribution utilities
docutils 0.19 Docutils -- Python Documentation Utilities
exceptiongroup 1.1.3 Backport of PEP 654 (exception groups)
filelock 3.12.2 A platform independent file lock.
flake8 6.1.0 the modular source code checker: pep8 pyflakes and co
frozenlist 1.4.0 A list-like structure which implements collections.abc.MutableSequence
fsspec 2023.6.0 File-system specification
furo 2023.8.19 A clean customisable Sphinx documentation theme.
gitdb 4.0.10 Git Object Database
gitpython 3.1.32 GitPython is a Python library used to interact with Git repositories
huggingface-hub 0.16.4 Client library to download and publish models, datasets and other repos on ...
identify 2.5.27 File identification library for Python
idna 3.4 Internationalized Domain Names in Applications (IDNA)
imagesize 1.4.1 Getting image size from png/jpeg/jpeg2000/gif file
iniconfig 2.0.0 brain-dead simple config-ini parsing
isort 5.12.0 A Python utility / library to sort Python imports.
jinja2 3.1.2 A very fast and expressive template engine.
langchain 0.0.240 Building applications with LLMs through composability
langsmith 0.0.25 Client library to connect to the LangSmith LLM Tracing and Evaluation Platf...
lazy-object-proxy 1.9.0 A fast and thorough lazy object proxy.
markdown-it-py 2.2.0 Python port of markdown-it. Markdown parsing, done right!
markupsafe 2.1.3 Safely add untrusted strings to HTML/XML markup.
marshmallow 3.20.1 A lightweight library for converting complex datatypes to and from native P...
marshmallow-enum 1.5.1 Enum field for Marshmallow
mccabe 0.7.0 McCabe checker, plugin for flake8
mdit-py-plugins 0.3.5 Collection of plugins for markdown-it-py
mdurl 0.1.2 Markdown URL utilities
multidict 6.0.4 multidict implementation
mypy-extensions 1.0.0 Type system extensions for programs checked with the mypy type checker.
myst-parser 1.0.0 An extended [CommonMark](https://spec.commonmark.org/) compliant parser,
nodeenv 1.8.0 Node.js virtual environment builder
numexpr 2.8.5 Fast numerical expression evaluator for NumPy
numpy 1.25.2 Fundamental package for array computing in Python
openai 0.27.8 Python client library for the OpenAI API
openapi-schema-pydantic 1.2.4 OpenAPI (v3) specification schema as pydantic class
packaging 23.1 Core utilities for Python packages
pathspec 0.11.2 Utility library for gitignore style pattern matching of file paths.
pbr 5.11.1 Python Build Reasonableness
platformdirs 3.10.0 A small Python package for determining appropriate platform-specific dirs, ...
pluggy 1.2.0 plugin and hook calling mechanisms for python
pre-commit 3.3.3 A framework for managing and maintaining multi-language pre-commit hooks.
pycodestyle 2.11.0 Python style guide checker
pydantic 1.10.12 Data validation and settings management using python type hints
pydocstyle 6.3.0 Python docstring style checker
pyflakes 3.1.0 passive checker of Python programs
pygments 2.16.1 Pygments is a syntax highlighting package written in Python.
pytest 7.4.0 pytest: simple powerful testing with Python
pytest-cov 4.1.0 Pytest plugin for measuring coverage.
python-dotenv 1.0.0 Read key-value pairs from a .env file and set them as environment variables
pyyaml 6.0.1 YAML parser and emitter for Python
regex 2023.8.8 Alternative regular expression module, to replace re.
requests 2.31.0 Python HTTP for Humans.
rich 13.5.2 Render rich text, tables, progress bars, syntax highlighting, markdown and ...
safetensors 0.3.2 Fast and Safe Tensor serialization
setuptools 68.1.2 Easily download, build, install, upgrade, and uninstall Python packages
smmap 5.0.0 A pure Python implementation of a sliding window memory map manager
snowballstemmer 2.2.0 This package provides 29 stemmers for 28 languages generated from Snowball ...
soupsieve 2.4.1 A modern CSS selector implementation for Beautiful Soup.
sphinx 6.2.1 Python documentation generator
sphinx-autoapi 1.9.0 Sphinx API documentation generator
sphinx-basic-ng 1.0.0b2 A modern skeleton for Sphinx themes.
sphinxcontrib-applehelp 1.0.7 sphinxcontrib-applehelp is a Sphinx extension which outputs Apple help books
sphinxcontrib-devhelp 1.0.5 sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp documents
sphinxcontrib-htmlhelp 2.0.4 sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files
sphinxcontrib-jsmath 1.0.1 A sphinx extension which renders display math in HTML via JavaScript
sphinxcontrib-qthelp 1.0.6 sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp documents
sphinxcontrib-serializinghtml 1.1.9 sphinxcontrib-serializinghtml is a sphinx extension which outputs "serializ...
sqlalchemy 2.0.20 Database Abstraction Library
stevedore 5.1.0 Manage dynamic plugins for Python applications
tenacity 8.2.3 Retry code until it succeeds
text-generation 0.6.0 Hugging Face Text Generation Python Client
tiktoken 0.4.0 tiktoken is a fast BPE tokeniser for use with OpenAI's models
tokenizers 0.13.3 Fast and Customizable Tokenizers
tomli 2.0.1 A lil' TOML parser
tqdm 4.66.1 Fast, Extensible Progress Meter
transformers 4.31.0 State-of-the-art Machine Learning for JAX, PyTorch and TensorFlow
tree-sitter 0.20.1 Python bindings to the Tree-sitter parsing library
typing-extensions 4.7.1 Backported and Experimental Type Hints for Python 3.7+
typing-inspect 0.9.0 Runtime inspection utilities for typing module.
unidecode 1.3.6 ASCII transliterations of Unicode text
urllib3 2.0.4 HTTP library with thread-safe connection pooling, file post, and more.
virtualenv 20.24.3 Virtual Python Environment builder
wrapt 1.15.0 Module for decorators, wrappers and monkey patching.
yarl 1.9.2 Yet another URL library |
Beta Was this translation helpful? Give feedback.
Replies: 5 comments 8 replies
-
|
I've been seeing this too and I'm pretty sure the latest release of Furo doesn't support Sphinx 6, even though it claims to. Upgrading to Sphinx 7 fixes it. (7.2.0 doesn't support setuptools currently, though, just as a warning - I've had to limit to <7.2 while that's being fixed in setuptools - only an issue if you are including setuptools API cross linking). Because of this, and because readthedocs still has Sphinx 6, it would be great if support could be restored for Sphinx 6 for a bit. FYI, you probably (guessing from Poetry) have |
Beta Was this translation helpful? Give feedback.
-
|
FYI, if you'd like a standalone reproducer, scientific-python/cookie#265 is a cookiecutter template broken by this. :) Also scikit-build-core and build readthedocs builds are both broken due to this. |
Beta Was this translation helpful? Give feedback.
-
|
I had a build failure on 6.2.1 as well, RTD build log. I just reran it to pull the latest Sphinx as a fix, so not a big issue on my end, just providing more evidence in case it is needed. (but I really wanted to post a huge thanks to @henryiii for those blog posts 🙇, I've referenced them in packaging discussions a few times already.) |
Beta Was this translation helpful? Give feedback.
-
What are you saying this on the basis of? I am definitely able to build documentation with the latest Sphinx 6 and latest Furo (HEAD is unchanged relatively to the latest release). |
Beta Was this translation helpful? Give feedback.
-
|
You can make an empty new project (I'm selecting vcs-versioning = False, everything else left default): $ cookiecutter gh:scientific-python/cookie
$ cd packageEdit pyproject.toml's docs extra to force Sphinx $ nox -s docs
nox > Running session docs
nox > Creating virtual environment (virtualenv) using python3.11 in .nox/docs
nox > python -m pip install '-e.[docs]'
nox > cd docs
nox > sphinx-build --keep-going -n -T -b=html . _build/html
Running Sphinx v6.2.1
making output directory... done
myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'colon_fence'}, disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
generating indices... genindex failed
Traceback (most recent call last):
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/cmd/build.py", line 285, in build_main
app.build(args.force_all, args.filenames)
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/application.py", line 353, in build
self.builder.build_update()
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 311, in build_update
self.build(to_build,
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 381, in build
self.finish()
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/builders/html/__init__.py", line 682, in finish
self.finish_tasks.add_task(self.gen_indices)
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/util/parallel.py", line 38, in add_task
res = task_func()
^^^^^^^^^^^
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/util/display.py", line 85, in wrapper
return f(*args, **kwargs)
^^^^^^^^^^^^^^^^^^
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/builders/html/__init__.py", line 698, in gen_indices
self.write_genindex()
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/builders/html/__init__.py", line 754, in write_genindex
self.handle_page('genindex', genindexcontext, 'genindex.html')
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/builders/html/__init__.py", line 1076, in handle_page
newtmpl = self.app.emit_firstresult('html-page-context', pagename,
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/application.py", line 481, in emit_firstresult
return self.events.emit_firstresult(event, *args,
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/events.py", line 117, in emit_firstresult
for result in self.emit(name, *args, allowed_exceptions=allowed_exceptions):
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/sphinx/events.py", line 96, in emit
results.append(listener.handler(self.app, *args))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/Users/henryschreiner/git/tmp/package/.nox/docs/lib/python3.11/site-packages/furo/__init__.py", line 179, in _html_page_context
raise ConfigError(
sphinx.errors.ConfigError: This documentation is not using `furo.css` as the stylesheet. If you have set `html_style` in your conf.py file, remove it.
Configuration error:
This documentation is not using `furo.css` as the stylesheet. If you have set `html_style` in your conf.py file, remove it.
nox > Command sphinx-build --keep-going -n -T -b=html . _build/html failed with exit code 2
nox > Session docs failed.This is the docs/conf.py (which also is rendered into https://learn.scientific-python.org/development/guides/docs/, but pasted here to make it easier to find): docs/conf.pyfrom __future__ import annotations
import importlib.metadata
project = "package"
copyright = "2023, My Name"
author = "My Name"
version = release = importlib.metadata.version("package")
extensions = [
"myst_parser",
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinx.ext.napoleon",
"sphinx_autodoc_typehints",
"sphinx_copybutton",
]
source_suffix = [".rst", ".md"]
exclude_patterns = [
"_build",
"**.ipynb_checkpoints",
"Thumbs.db",
".DS_Store",
".env",
".venv",
]
html_theme = "furo"
myst_enable_extensions = [
"colon_fence",
]
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
}
nitpick_ignore = [
("py:class", "_io.StringIO"),
("py:class", "_io.BytesIO"),
]
always_document_param_types = True |
Beta Was this translation helpful? Give feedback.
-
I linked to two projects that are failing (pypa/build and scikit-build/scikit-build-core), and gave a template repo link that is also failing. |
Beta Was this translation helpful? Give feedback.
-
|
Do folks have a reproducer for this issue? I'm unable to reproduce this with the latest bugfix releases of Sphinx 7 (as seen with the most recent docs build on GA) and Sphinx 6 (below). |
Beta Was this translation helpful? Give feedback.
-
|
Sure: $ gh repo clone pradyunsg/furo
$ cd furo
$ git checkout 2023.08.19
$ virtualenv .venv
$ . .venv/bin/activate.fish
$ pip install . sphinx~=6.0 -r docs/requirements.txt
$ sphinx-build -b dirhtml docs/ /tmp/dumpme && echo "[[It worked]]"
Running Sphinx v6.2.1
making output directory... done
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://www.sphinx-doc.org/en/master/objects.inv...
myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'deflist', 'colon_fence'}, disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=3, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output...
building [dirhtml]: targets for 44 source files that are out of date
updating environment: [new config] 44 added, 0 changed, 0 removed
reading sources... [100%] stability
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 4%] contributing/design
Configuration error:
This documentation is not using `furo.css` as the stylesheet. If you have set `html_style` in your conf.py file, remove it.(and it works fine if you use sphinx 7. It's also broken on the latest |
Beta Was this translation helpful? Give feedback.
-
|
Ah, ok. I've finally been able to reproduce this. This is a proper bug, yea. 😓 |
Beta Was this translation helpful? Give feedback.
-
|
I have encountered the same problem as The error spit out by the pipeline:
I didn't have I spent several hours debugging, and found out that version incompatibility between Instead of just using I hope this fix will help others to solve this problem temporarily for now, while a more permanent compatibility solution is resolved by the developers. |
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
running into the the same issue, with sphinx |
Beta Was this translation helpful? Give feedback.
-
|
#716 filed to tracking the fix for this. Thanks for reporting this! ^.^ |
Beta Was this translation helpful? Give feedback.
#716 filed to tracking the fix for this. Thanks for reporting this! ^.^