Skip to content

Fix RST formatting and double-dash escaping in config#741

Merged
ionelmc merged 5 commits into
pytest-dev:masterfrom
OlenaYefymenko:fix/docs-double-dash-escaping
Apr 24, 2026
Merged

Fix RST formatting and double-dash escaping in config#741
ionelmc merged 5 commits into
pytest-dev:masterfrom
OlenaYefymenko:fix/docs-double-dash-escaping

Conversation

@OlenaYefymenko
Copy link
Copy Markdown
Contributor

@OlenaYefymenko OlenaYefymenko commented Apr 15, 2026

This patch applies RST formatting to the configuration document, in particular it:

  • Adds the :file: role for .coveragerc, setup.cfg, pyproject.toml, and tox.ini;
  • Fixes the CLI options list formatting by switching to .. option:: directives;
  • Removes a stray > from the addopts reference URL;
  • Uses double backticks for --cov= and --cov-report= to prevent RST from rendering - as an em dash.

@OlenaYefymenko
Copy link
Copy Markdown
Contributor Author

OlenaYefymenko commented Apr 15, 2026

This is how it was rendered before the fix:
Screenshot From 2026-04-16 00-46-17

@webknjaz
Copy link
Copy Markdown
Member

This doesn't seem to be enough. And also, the unquoted options are seen in multiple places in that paragraph.

Comment thread docs/config.rst
@OlenaYefymenko OlenaYefymenko marked this pull request as draft April 16, 2026 08:49
Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
@OlenaYefymenko OlenaYefymenko marked this pull request as ready for review April 21, 2026 20:42
@OlenaYefymenko OlenaYefymenko marked this pull request as draft April 21, 2026 20:47
@webknjaz webknjaz linked an issue Apr 24, 2026 that may be closed by this pull request
@webknjaz webknjaz added documentation Discussions, feedback and improvements to the documentation website. needs more work labels Apr 24, 2026
@OlenaYefymenko OlenaYefymenko marked this pull request as ready for review April 24, 2026 19:33
@OlenaYefymenko
Copy link
Copy Markdown
Contributor Author

This doesn't seem to be enough. And also, the unquoted options are seen in multiple places in that paragraph.

Thank you for the review!

@OlenaYefymenko
Copy link
Copy Markdown
Contributor Author

Checked HTML rendering locally via sphinx-build
Screenshot From 2026-04-24 23-34-48

@OlenaYefymenko OlenaYefymenko changed the title Edit double-dash escaping for --cov= option in config.rst Fix RST formatting and double-dash escaping in config.rst Apr 24, 2026
@OlenaYefymenko OlenaYefymenko changed the title Fix RST formatting and double-dash escaping in config.rst Fix RST formatting and double-dash escaping in config Apr 24, 2026
@webknjaz webknjaz requested a review from ionelmc April 24, 2026 21:12
@webknjaz
Copy link
Copy Markdown
Member

@ionelmc FTR, the linkcheck issues are related to GitHub's recent increase in aggressive rate limiting measures of unauthenticated HTTP requests.

@ionelmc ionelmc merged commit 574f0c5 into pytest-dev:master Apr 24, 2026
64 of 68 checks passed
@ionelmc
Copy link
Copy Markdown
Member

ionelmc commented Apr 24, 2026

That is fine. There's no release automation depending on that completing. Thanks everyone.

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

Labels

documentation Discussions, feedback and improvements to the documentation website. needs more work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Configuration Page has a Rendering Issue

3 participants