Visit our Popular Forums

rgleason · 28-12-2023, 07:24

When I pushed the change to sphinx 4.3.0 and tried to build readthedocs it failed again. Don't understand this error. Should I try python 3.9?

Build #22969265
latest (6d34ba04512067f40dcce3862cdd52c112e10c68)
Build failed
Error

We encountered a problem with a command while building your project. To resolve this error, double check your project configuration and installed dependencies are correct and have not changed recently.

Quote:

File "/home/docs/checkouts/readthedocs.org/user_builds/dashboard-tactics-pi/envs/latest/lib/python3.11/site-packages/jinja2/__init__.py", line 12, in <module>
from .environment import Environment
File "/home/docs/checkouts/readthedocs.org/user_builds/dashboard-tactics-pi/envs/latest/lib/python3.11/site-packages/jinja2/environment.py", line 25, in <module>
from .defaults import BLOCK_END_STRING
File "/home/docs/checkouts/readthedocs.org/user_builds/dashboard-tactics-pi/envs/latest/lib/python3.11/site-packages/jinja2/defaults.py", line 3, in <module>
from .filters import FILTERS as DEFAULT_FILTERS # noqa: F401
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/docs/checkouts/readthedocs.org/user_builds/dashboard-tactics-pi/envs/latest/lib/python3.11/site-packages/jinja2/filters.py", line 13, in <module>
from markupsafe import soft_unicode
ImportError: cannot import name 'soft_unicode' from 'markupsafe' (/home/docs/checkouts/readthedocs.org/user_builds/dashboard-tactics-pi/envs/latest/lib/python3.11/site-packages/markupsafe/__init__.py)

nohal · 28-12-2023, 07:35

Even newer Sphinx, maybe.

rgleason · 28-12-2023, 08:03

Sphinx Release 4.3.0 (released Nov 11, 2021)
Dependencies
Support Python 3.10
There are "incompatible changes" and "depricated" items....?

I could dial back python to 3.10?
also perhaps move Sphinx Release 4.4.0 (released Jan 17, 2022) which fixes a lot with no downside.

nohal · 28-12-2023, 08:13

Rick, I really don't know. You don't need to ask me about every random thing you are going to try.

rgleason · 28-12-2023, 08:25

Tried that. Same error
Build #22969597
latest (7ea79c0ba99d035f389ee0c754ca6a0b184676bd)
Build failed
Error

We encountered a problem with a command while building your project. To resolve this error, double check your project configuration and installed dependencies are correct and have not changed recently.

Quote:

File "/home/docs/checkouts/readthedocs.org/user_builds/dashboard-tactics-pi/envs/latest/lib/python3.10/site-packages/jinja2/filters.py", line 13, in <module> from markupsafe import soft_unicode ImportError: cannot import name 'soft_unicode' from 'markupsafe' (/home/docs/checkouts/readthedocs.org/user_builds/dashboard-tactics-pi/envs/latest/lib/python3.10/site-packages/markupsafe/__init__.py)

rgleason · 28-12-2023, 08:33

From sphinx changelog
Release 3.3.1 (released Nov 12, 2020)
Bugs fixed

#8372: autodoc: autoclass directive became slower than Sphinx 3.2
#7727: autosummary: raise PycodeError when documenting python package without __init__.py

https://github.com/pallets/markupsafe/issues/284
https://duckduckgo.com/?q=cannot+imp...=v362-1&ia=web
https://bobbyhadz.com/blog/python-im...rom-markupsafe
https://sebhastian.com/importerror-c...om-markupsafe/

nohal · 28-12-2023, 08:37

Your problem is the mismatch between Jinja and markupsafe. None of these are explicitly pulled in so they are dependencies of something you are using.
I don't know what, so you simply either have to investigate yourself (and actually understand the thing) or keep trying changing the versions until you find a working combination.
This is absolutely normal when you update the environment under something that has been abandoned for several years and I simply don't have any better advice for you.

You don't need to post random irrelevant snippets from Sphinx changelog, I have of course already seen it all and there is no mention of the particular problem you are seeing being explicitly addressed in some release.

nohal · 28-12-2023, 10:06

If I use this in requirements.txt, the documentation is buildable on my machine. If it is usable on the ReadTheDocs image I do not know, but you may try

Code:

ipykernel==6.28.0
nbsphinx==0.9.3
Sphinx==7.2.6

nohal · 28-12-2023, 10:11

you may also need to replace this line: https://github.com/rgleason/dashboar...ce/conf.py#L47

with

Code:

source_suffix = ['.rst']

rgleason · 28-12-2023, 12:11

Thanks Pavel, I of course haven't a clue about what I am doing. I am just trying to recreate something that was working, with a lot of help from you! I will give those things a try.

rgleason · 28-12-2023, 12:25

In requirements.txt should I remove
Pygments==2.9.0 ?

rgleason · 28-12-2023, 12:30

Pavel see this

https://github.com/rgleason/dashboar...ns/20013650527
https://app.circleci.com/pipelines/g...?branch=master

What is publishfocal? Is this coming from readthedocs? Why would I want to publish? Why there?
It is trying to publish to cloudsmith? If so, I think I might have to enable it, although the plugin CI is all in place.

rgleason · 28-12-2023, 12:38

https://readthedocs.org/projects/das...ilds/22970951/

Quote:

Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/dashboard-tactics-pi/envs/latest/lib/python3.10/site-packages (from Sphinx==7.2.6->-r docs/readthedocs/requirements.txt (line 3)) (1.0.6)
INFO: pip is looking at multiple versions of sphinx to determine which version is compatible with other requirements. This could take a while.
ERROR: Cannot install Pygments==2.9.0 and sphinx==7.2.6 because these package versions have conflicting dependencies.

The conflict is caused by:
The user requested Pygments==2.9.0
sphinx 7.2.6 depends on Pygments>=2.14

To fix this you could try to:
1. loosen the range of package versions you've specified
2. remove package versions to allow pip attempt to solve the dependency conflict

Should I remove Pygments==2.9.0
or change to Pygments>=2.14 ?