Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sphinx configuration key for readthedocs #294

Merged
merged 1 commit into from
Jan 24, 2025

Conversation

timwoj
Copy link
Member

@timwoj timwoj commented Jan 23, 2025

RTD started enforcing the existence of this key in their yml file as of 2025/01/20. See https://about.readthedocs.com/blog/2024/12/deprecate-config-files-without-sphinx-or-mkdocs-config/ for more info. https://readthedocs.org/projects/zeek-docs/builds/26952573/ is a build that includes the config option for testing.

Our master builds are currently failing due to the lack of this key.

Copy link
Contributor

@awelzel awelzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spicy has the key already, Broker does not. Any other readthedocs projects that may need a look?

@timwoj
Copy link
Member Author

timwoj commented Jan 24, 2025

zkg is the only other one that uses readthedocs and it has it already. I'll open a PR on the broker side do a build there for sanity checking.

@timwoj timwoj merged commit 0fd963f into master Jan 24, 2025
11 checks passed
@timwoj timwoj deleted the topic/timw/add-sphinx-configuration-key branch January 24, 2025 17:39
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