Skip to content

docs: dash-dash-opt into literal or link - #3328

Closed
pajod wants to merge 1 commit into
benoitc:masterfrom
pajod:docs-dash-hyphen-ref
Closed

docs: dash-dash-opt into literal or link#3328
pajod wants to merge 1 commit into
benoitc:masterfrom
pajod:docs-dash-hyphen-ref

Conversation

@pajod

@pajod pajod commented Nov 24, 2024

Copy link
Copy Markdown
Contributor

Replace all the --opt that sphinx might rewrite into –opt (typographical alternates, not accepted by argparse) by literals, or references (where applicable). Also change some https:// references into internal ones, preventing unintended navigation between doc versions.

Comment thread docs/source/2021-news.rst
Comment on lines 19 to +20
- allows to set wsgi application in config file using `wsgi_app`
- document `--timeout = 0`
- document ``--``:ref:`timeout=0<timeout>`

@pajod pajod Nov 24, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is intentional. Looks weird, but only so because reStructuredText parsers are weird - no way to express a literal reference.

@benoitc

benoitc commented Jan 22, 2026

Copy link
Copy Markdown
Owner

Closing this documentation PR. Note: We're migrating away from Sphinx to MkDocs in the next version (see PR #3426), so these RST documentation changes will no longer be applicable. Thank you for the contribution.

@benoitc benoitc closed this Jan 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.

2 participants