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

Post: doctools without configuration file deprecation announcement #229

Merged
merged 4 commits into from
Jul 12, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions doctool-without-configuration-file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. post:: July 12, 2023
:tags: builders
:author: Manuel
:location: BCN
:category: Changelog

Doctools without configuration file (`conf.py` / `mkdocs.yml`) are deprecated
=============================================================================

Historically Read the Docs has created a `conf.py` file for Sphinx projects and a `mkdocs.yml` file for MkDocs projects that don't provide one,
to make onboarding easier.
This has been confusing a lot our users in different ways and **we will remove the auto-creation of a default Sphinx/MkDocs configuration file for projects that don't have one on August 28th**.
To avoid unexpected behavior or your documentation builds failing,
you should add a configuration file to your project by this date.

The auto-creation of a default configuration file will be completely removed on **August 28th**. Add a `conf.py`/`mkdocs.yml` to your projects before this date to avoid unexpected build failures.

You can find a good example of a basic configuration file in our :doc:`example projects <readthedocs:examples>`:

* Sphinx `example conf.py <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/docs/conf.py>`_
* Mkdocs `example mkdocs.yml <https://github.com/readthedocs-examples/example-mkdocs-basic/blob/main/mkdocs.yml>`_

Please `contact us`_ about any issues you have regarding change.

.. _contact us: mailto:hello@readthedocs.org