Skip to content

Add missing RTD configuration file, which is obligatory today#488

Merged
martindurant merged 1 commit into
python-streamz:masterfrom
daq-tools:fix-rtd
Dec 17, 2025
Merged

Add missing RTD configuration file, which is obligatory today#488
martindurant merged 1 commit into
python-streamz:masterfrom
daq-tools:fix-rtd

Conversation

@amotl

@amotl amotl commented Dec 17, 2025

Copy link
Copy Markdown
Contributor

Problem

It looks like the RTD configuration file was missing. It was optional before, but is obligatory today.

References

@amotl

amotl commented Dec 17, 2025

Copy link
Copy Markdown
Contributor Author

@martindurant: You said you've enabled the RTD feature to run on pull requests.

image

-- https://app.readthedocs.org/dashboard/streamz/edit/

However, it is currently not showing up within the GHA PR builder widget (below). Well, maybe this patch needs to be merged before things start working this way, we'll see. In this spirit, I haven't been able to validate the patch / configuration file yet, so you might need to go into a quick trial-and-error cycle at your disposal, if it doesn't work out of the box.

@martindurant

Copy link
Copy Markdown
Member

Understood. That is indeed the button I clicked, so we'll see.

@martindurant martindurant merged commit dc19ab0 into python-streamz:master Dec 17, 2025
7 checks passed
@martindurant

Copy link
Copy Markdown
Member

The build still fails, but now complaining that streamz itself is not installed:

Traceback (most recent call last):
  | File "/home/docs/checkouts/readthedocs.org/user_builds/streamz/envs/latest/lib/python3.14/site-packages/sphinx/config.py", line 601, in eval_config_file
  | exec(code, namespace)  # NoQA: S102
  | ~~~~^^^^^^^^^^^^^^^^^
  | File "/home/docs/checkouts/readthedocs.org/user_builds/streamz/checkouts/latest/docs/source/conf.py", line 59, in <module>
  | import streamz
  | ModuleNotFoundError: No module named 'streamz'
  |  
  | The above exception was the direct cause of the following exception:
  |  
  | Traceback (most recent call last):
  | File "/home/docs/checkouts/readthedocs.org/user_builds/streamz/envs/latest/lib/python3.14/site-packages/sphinx/cmd/build.py", line 414, in build_main
  | app = Sphinx(
  | srcdir=args.sourcedir,
  | ...<14 lines>...
  | exception_on_warning=args.exception_on_warning,
  | )
  | File "/home/docs/checkouts/readthedocs.org/user_builds/streamz/envs/latest/lib/python3.14/site-packages/sphinx/application.py", line 266, in __init__
  | self.config = Config.read(self.confdir, confoverrides or {}, self.tags)
  | ~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  | File "/home/docs/checkouts/readthedocs.org/user_builds/streamz/envs/latest/lib/python3.14/site-packages/sphinx/config.py", line 357, in read
  | namespace = eval_config_file(filename, tags)
  | File "/home/docs/checkouts/readthedocs.org/user_builds/streamz/envs/latest/lib/python3.14/site-packages/sphinx/config.py", line 616, in eval_config_file
  | raise ConfigError(msg % traceback.format_exc()) from exc
  | sphinx.errors.ConfigError: There is a programmable error in your configuration file:
  |  
  | Traceback (most recent call last):
  | File "/home/docs/checkouts/readthedocs.org/user_builds/streamz/envs/latest/lib/python3.14/site-packages/sphinx/config.py", line 601, in eval_config_file
  | exec(code, namespace)  # NoQA: S102
  | ~~~~^^^^^^^^^^^^^^^^^
  | File "/home/docs/checkouts/readthedocs.org/user_builds/streamz/checkouts/latest/docs/source/conf.py", line 59, in <module>
  | import streamz
  | ModuleNotFoundError: No module named 'streamz'
  |  

@amotl

amotl commented Dec 17, 2025

Copy link
Copy Markdown
Contributor Author

Thank you. I will try to compensate. I wasn't aware that it also needs the package itself for generating API docs, but well, I could have seen it when looking more closely ;].

-- https://streamz.readthedocs.io/en/latest/api.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants