Skip to content

Commit

Permalink
Docs: update reproducible builds guide (#10939)
Browse files Browse the repository at this point in the history
* Rework first section as the config file is mandatory now

* Add an admonition about the versions used here

* Update requirements.txt example with more recent versions

* Update the pip-compile example with recent versions

* Revert 8256440 and 90d1687 as requested

* Link to the config file tutorial

* Typo
  • Loading branch information
duboism authored Sep 30, 2024
1 parent 445bc29 commit 6680d0e
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/user/guides/reproducible-builds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,18 @@ so that you can focus on content.
:local:
:depth: 3

.. note::
This page explains how to pin the versions that correctly build your project.
The versions used in this page are just for illustrative purpose.
They are not the latest nor the recommended versions.
It is up to you to find those versions.

Define OS and tool versions in the config file
----------------------------------------------

We recommend defining the explicit version of the OS and tool versions used to build your documentation
using the ``.readthedocs.yaml``.
This file file *provides you per version settings*,
This file *provides you per version settings*,
and *those settings live in your Git repository*.

This allows you to validate changes using :doc:`pull requests </pull-requests>`,
Expand Down

0 comments on commit 6680d0e

Please sign in to comment.