Skip to content

ci: remove hacks for docs building - #462

Merged
flying-sheep merged 1 commit into
mainfrom
pa/remove-doc-hacks
Jan 7, 2026
Merged

ci: remove hacks for docs building#462
flying-sheep merged 1 commit into
mainfrom
pa/remove-doc-hacks

Conversation

@flying-sheep

@flying-sheep flying-sheep commented Jan 7, 2026

Copy link
Copy Markdown
Member

Inspired by @eroell: https://scverse.zulipchat.com/#narrow/channel/316218-repo-management/topic/cookiecutter.20template.20release/near/566723956

On Python ≤3.13, sphinx-autodoc-typehints uses :data:`typing.Union` which only works when linking to https://docs.python.org/3.13 (or lower).

There are two ways to remove the hack, both of which used in here:

  1. since RTD supports Python 3.14 now, build docs with 3.14
  2. set always_use_bars_union = True (also done, so the docs hatch env can use any Python version)

@github-actions

github-actions Bot commented Jan 7, 2026

Copy link
Copy Markdown

A PR has been generated to the instance repo:
scverse/cookiecutter-scverse-instance#250

You can check out the PR to preview your changes
in an instance of the cookiecutter template. The PR will be kept in sync with
this PR automatically.

@flying-sheep
flying-sheep requested a review from Zethson January 7, 2026 13:02

@Zethson Zethson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you!

@flying-sheep
flying-sheep merged commit c6678be into main Jan 7, 2026
8 checks passed
@flying-sheep
flying-sheep deleted the pa/remove-doc-hacks branch January 7, 2026 13:08
This was referenced Jul 17, 2026
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.

2 participants