Skip to content

DOC: avoid a standalone page for included terminal options - #15417

Merged
Carreau merged 1 commit into
ipython:mainfrom
harbinresearcher:codex/fix-terminal-options-docs
Oct 22, 2026
Merged

Carreau merged 1 commit into
ipython:mainfrom
harbinresearcher:codex/fix-terminal-options-docs

Conversation

@harbinresearcher

Copy link
Copy Markdown

Closes #15415.

The generated config/options/terminal.rst is included in the titled options/index.rst page, but Sphinx also discovers it as a standalone document. That produces an untitled duplicate page and registers configuration-trait links against terminal.html.

Exclude the included file from standalone document discovery. The include remains unchanged, so the configuration options stay on options/index.html and configuration-trait references resolve there. Update the direct reference in the IPython 5 release notes to the canonical page as well.

Agent-assisted contribution. 🤖🤖

@harbinresearcher

Copy link
Copy Markdown
Author

The Build docs check has passed. Both MyPy jobs report IPython/core/kitty.py:114: Statement is unreachable [unreachable] during the win32 platform check. This PR only changes two documentation lines; kitty.py and the type-checking configuration are unchanged from the base commit. I have left that failure outside this documentation fix.

@Carreau
Carreau force-pushed the codex/fix-terminal-options-docs branch from 027c96d to 905a5d7 Compare October 21, 2026 12:14
@Carreau
Carreau merged commit 0ed4a9e into ipython:main Oct 22, 2026
23 checks passed
@Carreau Carreau added this to the 9.18 milestone Oct 22, 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.

DOC: /config/options/terminal.html has "<no title>"

2 participants