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

sphinx generates \(aq for ' #591

Open
ofaaland opened this issue Oct 21, 2024 · 2 comments
Open

sphinx generates \(aq for ' #591

ofaaland opened this issue Oct 21, 2024 · 2 comments

Comments

@ofaaland
Copy link
Collaborator

When .rst files have an apostrophe, sphinx generates "\aq" in its place in the corresponding man page.

Observed with:
mpifileutils tag v0.11.1
sphinx 5.3.0
python 3.6

For example, in doc/rst/dcp.1.rst text

   Do not follow symbolic links in source paths. Effectviely allows
   symbolic links to be copied when the link target is not valid
   or there is not permission to read the link's target.

generates

Do not follow symbolic links in source paths. Effectviely allows
symbolic links to be copied when the link target is not valid
or there is not permission to read the link\(aqs target.

in man/dcp.1.

@ofaaland
Copy link
Collaborator Author

Adding backslashes or doubling the apostrophe doesn't change behavior. \(aq is substituted for ' if the source .rst file contains any of the below examples:

link''s
link'''s
link\'s
link\\'s
link\\\'s

@ofaaland
Copy link
Collaborator Author

"aq" means "apostrophe, neutral single quote" in groff:
https://man7.org/linux/man-pages/man7/groff_char.7.html

and indeed, when I look at the dcp.1 man page produced by sphinx which has the link\(aqs target using the command-line man page rader on rhel 8.10, the apostrophe appears as it should.

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

1 participant