Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrong quotes in sphinx documentation #171

Open
arialcrime opened this issue Sep 29, 2022 · 3 comments
Open

Wrong quotes in sphinx documentation #171

arialcrime opened this issue Sep 29, 2022 · 3 comments

Comments

@arialcrime
Copy link

Even though the correct kind of (straight) quotes are used in the docstrings, the rendered documentation changes them to “typographic” ones. This makes copying from the documentation a bit more tedious than it has to be.

@justvanrossum
Copy link
Collaborator

Perhaps backticks should be used in the doc string:

*`"should close"`*

@arialcrime
Copy link
Author

That sounds extensive. Maybe explicitly setting this to False already solves it?

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

@justvanrossum
Copy link
Collaborator

Generally we need to mark code fragments as "code", and I would say the smarty pants behavior is desirable for non-code.

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

No branches or pull requests

2 participants