Skip to content

Allow documentation builds on Windows#3227

Merged
A5rocks merged 10 commits intopython-trio:mainfrom
A5rocks:experiments/universal-docs
Jun 29, 2025
Merged

Allow documentation builds on Windows#3227
A5rocks merged 10 commits intopython-trio:mainfrom
A5rocks:experiments/universal-docs

Conversation

@A5rocks
Copy link
Copy Markdown
Contributor

@A5rocks A5rocks commented Mar 20, 2025

Fixes #3071

I'm not totally sure about all changes here. Some are likely only because my local installation of Python is 3.13.

Also this is definitely not the cleanest method of doing this :P

@A5rocks A5rocks added the skip newsfragment Newsfragment is not required label Mar 20, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00000%. Comparing base (efd785a) to head (03a78ca).
⚠️ Report is 83 commits behind head on main.

Additional details and impacted files
@@               Coverage Diff               @@
##                 main        #3227   +/-   ##
===============================================
  Coverage   100.00000%   100.00000%           
===============================================
  Files             127          127           
  Lines           19257        19266    +9     
  Branches         1301         1303    +2     
===============================================
+ Hits            19257        19266    +9     
Files with missing lines Coverage Δ
src/trio/_channel.py 100.00000% <ø> (ø)
src/trio/_core/__init__.py 100.00000% <100.00000%> (ø)
src/trio/_core/_run.py 100.00000% <ø> (ø)
src/trio/_highlevel_socket.py 100.00000% <100.00000%> (ø)
src/trio/_path.py 100.00000% <100.00000%> (ø)
src/trio/_tests/test_unix_pipes.py 100.00000% <ø> (ø)
src/trio/_timeouts.py 100.00000% <ø> (ø)
src/trio/_unix_pipes.py 100.00000% <ø> (ø)
src/trio/lowlevel.py 100.00000% <100.00000%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@TeamSpen210
Copy link
Copy Markdown
Contributor

Makes sense to me. I've always just ignored the FDStream error in logs when building, since I didn't need to test that bit.

@jakkdl
Copy link
Copy Markdown
Member

jakkdl commented Jun 5, 2025

I'm not totally sure about all changes here. Some are likely only because my local installation of Python is 3.13.

you can test this with tox -e docs, though you'll either need to manually modify the base_python variable between runs or change the definition to [testenv:py{39,310,311,312,313}-docs]

Or rather, .readthedocs.yml and the docs environment both specify 3.11, so you don't need to verify on any other versions. We might want to bump from 311 to 313 though

@A5rocks
Copy link
Copy Markdown
Contributor Author

A5rocks commented Jun 6, 2025

so you don't need to verify on any other versions

Yeah, I don't remember what I was thinking when writing that initial comment (probably was just because I wasn't sure RTD would pass...)

@A5rocks
Copy link
Copy Markdown
Contributor Author

A5rocks commented Jun 27, 2025

Are there any issues with this? I'd like to merge this otherwise.

Copy link
Copy Markdown
Member

@CoolCat467 CoolCat467 left a comment

Choose a reason for hiding this comment

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

Looks good as far as I can tell, just don't let the TODO comment be forgotten

@A5rocks A5rocks merged commit 79f685f into python-trio:main Jun 29, 2025
43 checks passed
@A5rocks A5rocks deleted the experiments/universal-docs branch June 29, 2025 05:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip newsfragment Newsfragment is not required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow building docs on Windows

4 participants