Skip to content

Commit 6680d0e

Browse files
authored
Docs: update reproducible builds guide (#10939)
* 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
1 parent 445bc29 commit 6680d0e

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/user/guides/reproducible-builds.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,18 @@ so that you can focus on content.
1212
:local:
1313
:depth: 3
1414

15+
.. note::
16+
This page explains how to pin the versions that correctly build your project.
17+
The versions used in this page are just for illustrative purpose.
18+
They are not the latest nor the recommended versions.
19+
It is up to you to find those versions.
20+
1521
Define OS and tool versions in the config file
1622
----------------------------------------------
1723

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

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

0 commit comments

Comments
 (0)