Thanks to visit codestin.com
Credit goes to github.com

Skip to content

NOMRG Testing numpydoc#154 #10444

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

Closed
wants to merge 1 commit into from

Conversation

jnothman
Copy link
Member

Testing documentation rendering with numpy/numpydoc#154 which should fix issues with attribute names being hyperlinked

@jnothman
Copy link
Member Author

Not happy. The \s are showing in scikit-learn rendered docs. It seems that docutils will treat some backslashes in the terms of definition lists as literal rather than escape characters.

Thus

hello\_ : hello\_
    hello\_
hello\* : hello\*
    hello\*
hello\\ : hello\\
    hello\\
hello\` : hello\`
    hello\`

renders in HTML as

hello\_ : hello\_
    hello_
hello\* : hello\*
    hello*
hello\ : hello\
    hello\
hello` : hello`
    hello`

even just through rst2html. I have no idea why this should be the case.

@jnothman
Copy link
Member Author

Apparently this is fixed in docutils 0.15 dev :\

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

Successfully merging this pull request may close these issues.

1 participant