Trim leading whitespace characters along doctest flags#13164

Merged

AA-Turner merged 3 commits intosphinx-doc:masterfrom

m-aciek:trim-spaces-with-doctest-flags

Jan 4, 2025

Contributor

m-aciek commented Dec 4, 2024 •

edited

Loading

Subject: trim leading whitespaces along with doctest flags comments

Feature or Bugfix

Feature

Purpose

improve rendering of doctest blocks by removing trailing spaces from the output

Detail

extra trailing spaces can be seen in the code blocks output in a line where doctest comment is in the source code (note extra highlight after the dir(sys)

Zrzut ekranu 2024-12-5 o 00 45 19

it indirectly is causing sphinx-lint failures in a translated code blocks, as the sphinx-lint disallows trailing spaces

Related

Wrong reading of literal-block content in PO files sphinx-contrib/sphinx-lint#120

m-aciek force-pushed the trim-spaces-with-doctest-flags branch from 7576637 to 39542bd Compare

December 4, 2024 23:53


          Trim leading whitespace characters along doctest flags

8ba1171

m-aciek force-pushed the trim-spaces-with-doctest-flags branch from 39542bd to 8ba1171 Compare

December 4, 2024 23:54

m-aciek changed the title ~~Trim leading spaces along doctest flags~~ Trim leading whitespace characters along doctest flags

m-aciek mentioned this pull request

Wrong reading of literal-block content in PO files sphinx-contrib/sphinx-lint#120

Open

jdillard added the extensions:doctest label

AA-Turner reviewed

View reviewed changes

tests/test_transforms/test_transforms_post_transforms_code.py Show resolved Hide resolved

AA-Turner reviewed

View reviewed changes

sphinx/ext/doctest.py Outdated Show resolved Hide resolved

AA-Turner added this to the 8.2.0 milestone

m-aciek added 2 commits

January 4, 2025 00:03


          Add positive case for trimming the do test comments in test_trim_doct…

86c8b2f

…est_flags_html()


          Narrow down regex pattern

badf69f

AA-Turner merged commit ad0c343 into sphinx-doc:master

Member

AA-Turner commented Jan 4, 2025

Thanks!

A

m-aciek deleted the trim-spaces-with-doctest-flags branch

January 24, 2025 09:45

m-aciek mentioned this pull request

Lint Failues python/python-docs-pl#57

Closed

31 tasks

github-actions bot locked as resolved and limited conversation to collaborators

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

extensions:doctest