Skip to content

Docs: Add some messages flagging the upcoming requirement of a .readthedocs.yaml #10389

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

Merged
merged 8 commits into from
Jun 8, 2023
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@
"rst-to-myst": ("https://rst-to-myst.readthedocs.io/en/stable/", None),
"rtd": ("https://docs.readthedocs.io/en/stable/", None),
"rtd-dev": ("https://dev.readthedocs.io/en/latest/", None),
"rtd-blog": ("https://blog.readthedocs.com/", None),
"jupyter": ("https://docs.jupyter.org/en/latest/", None),
}

Expand Down
4 changes: 2 additions & 2 deletions docs/user/config-file/v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Read the Docs has support for configuring builds with a YAML file.

.. warning::

Version 1 is deprecated and shouldn't be used.
The version 2 of the configuration file is now available.
Version 1 is deprecated and :doc:`support will be removed in September 2023 <rtd-blog:migrate-configuration-v2>`.
You should use version 2 of the configuration file.
See the :ref:`new features <config-file/v2:New settings>`
and :ref:`how to migrate from v1 <config-file/v2:Migrating from v1>`.

Expand Down
9 changes: 7 additions & 2 deletions docs/user/intro/import-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,16 @@ and the documentation will be built.
Check out our :doc:`/builds` page to learn more about how Read the Docs builds your docs,
and to troubleshoot any issues that arise.

Some documentation projects require additional configuration to build
such as specifying a certain version of Python or installing additional dependencies.
We require an additional configuration file to build your project.
This allows you to specifying special requirements for your build,
such as your version of Python or how you wish to install addition Python requirements.
You can configure these settings in a ``.readthedocs.yaml`` file.
See our :doc:`/config-file/index` docs for more details.

.. note::

Using a configuration file :doc:`is required from September 2023 <rtd-blog:migrate-configuration-v2>`.

It is also important to note that the default version of Sphinx is ``v1.8.5``.
We recommend to set the version your project uses :doc:`explicitily with pinned dependencies </guides/reproducible-builds>`.

Expand Down
20 changes: 15 additions & 5 deletions docs/user/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -284,8 +284,14 @@ you will access the build logs,
otherwise it will take you directly to the documentation.
When you are satisfied, you can merge the pull request!

Customizing the build process
-----------------------------
Adding a configuration file
---------------------------
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this section rename works well for the tutorial. It speaks more directly to the actionable item.

image


We are currently updating this tutorial.
:doc:`As of September 2023, you need to add a configuration file as mentioned in these steps <rtd-blog:migrate-configuration-v2>`.
Until then,
the tutorial's example project will build without the configuration file.
But we **highly** recommend completing this section in order to add a configuration file.

The Settings page of the :term:`project home` allows you
to change some *global* configuration values of your project.
Expand All @@ -297,9 +303,13 @@ This has several advantages:
- It can be different for every version (more on versioning in the next section).
- Some configurations are only available using the config file.

Read the Docs works without this configuration
by :ref:`making some decisions on your behalf <build-default-versions:Default versions of dependencies>`.
For example, what Python version to use, how to install the requirements, and others.
This configuration file should be part of your Git repository.
It should be located in the base folder of the repository and be named ``.readthedocs.yaml``.

.. TODO: We are adding a how-to that we need to include in this tutorial.
.. Maybe by reference or maybe as full-featured content.

In this section, we will show you some examples of what a configuration file should contain.

.. tip::

Expand Down