pallets-eco / pallets-eco/flask-debugtoolbar

ReadTheDocs will require an additional config file after Jan 20th, 2025

Open Beginner friendly
#297 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
JavaScript
Stars
978
Forks
151
PR merge metrics
No merged PRs in 30d

Description

Just got this in my email:

Hello,
We are announcing the deprecation of projects using Sphinx or MkDocs without an explicit configuration in their .readthedocs.yaml file. After January 20, 2025, Read the Docs will require explicit configuration for all Sphinx and MkDocs projects.

We used to automatically try to find the configuration file for your project, but in order to make builds more explicit and predictable, we are deprecating this behavior. This will also allows us to better support projects that don't use Sphinx or MkDocs in the near future.

What do I need to do?
If you're using Sphinx or MkDocs, ensure your .readthedocs.yaml file includes the appropriate configuration key. For example:

For Sphinx projects:

version: 2
sphinx:
configuration: docs/conf.py
For MkDocs projects:

version: 2
mkdocs:
configuration: mkdocs.yml
Note: If you're using build.commands, no changes are required.

Deprecation timeline
We will implement this change gradually:

January 6, 2025: Builds will be temporarily disabled for 12 hours (00:01 PST to 11:59 PST)
January 13, 2025: Builds will be temporarily disabled for 24 hours (00:01 PST to 23:59 PST)
January 20, 2025: Final cutoff date - builds without explicit configuration will be permanently disabled
Are my projects affected?
We found the following projects where you are a maintainer that may be impacted by this change:

flask-debugtoolbar

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the repository's .readthedocs.yaml file and identify whether the documentation uses Sphinx or MkDocs. Add the corresponding explicit configuration named in the issue, then verify that the Read the Docs configuration remains valid and the documentation build succeeds.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.