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

Run RTD build using pinned Sphinx version #52

Merged
merged 2 commits into from
Mar 22, 2021
Merged

Run RTD build using pinned Sphinx version #52

merged 2 commits into from
Mar 22, 2021

Conversation

amotl
Copy link
Member

@amotl amotl commented Dec 14, 2020

Out of curiosity, this checks the RTD build using a pinned Sphinx version. This is all about investigating the default/non-default behavior related to readthedocs/readthedocs.org#6296.

The background on that is that the RTD build says it is Running Sphinx v1.8.5 [1] when running on a loose constraint like Sphinx>=1.8.5,<4 as defined within crate-docs-theme [2], which is pulled in as a dependency.

[1] https://readthedocs.org/projects/crate-docs/builds/12559570/
[2] https://github.com/crate/crate-docs-theme/blob/0.12.0/setup.py#L56

@amotl
Copy link
Member Author

amotl commented Dec 14, 2020

Indeed, only when explicitly pinning to sphinx==3.3.1 here, the RTD build says it is Running Sphinx v3.3.1 [3]. However, @mechanomi also just suggested that "wiping" the RTD environment would also help, so nevermind.

[3] https://readthedocs.org/projects/crate-docs/builds/12559602/

@amotl
Copy link
Member Author

amotl commented Dec 14, 2020

Still, even after wiping the RTD latest environment at [4] and after pushing to #50, it says Running Sphinx v1.8.5 [5]. Let's come back to this later.

[4] https://readthedocs.org/projects/crate-docs/versions/
[5] https://readthedocs.org/projects/crate-docs/builds/12559720/

@amotl
Copy link
Member Author

amotl commented Mar 18, 2021

Now, I've pinned the demo docs project to Sphinx 3.5.2, and, indeed, [1] says it is Running Sphinx v3.5.2. By doing it that way, we are following the recommendations of the Reproducible Builds documentation of Read the Docs, specifically the Pinning dependencies section [2].

[1] https://readthedocs.org/api/v2/build/13282535.txt
[2] https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html#pinning-dependencies

@amotl amotl marked this pull request as ready for review March 18, 2021 19:00
@amotl amotl requested review from a team and nomicode March 18, 2021 19:00
@amotl amotl changed the title Check RTD build using pinned Sphinx Run RTD build using pinned Sphinx version Mar 18, 2021
@amotl
Copy link
Member Author

amotl commented Mar 18, 2021

With fc29c7f, we are also using an explicitly pinned Sphinx version within the common-build requirements.txt.

@amotl amotl force-pushed the amo/pin-sphinx branch 2 times, most recently from 207e0f9 to b2e9cc4 Compare March 22, 2021 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants