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

Parameter docs render text in backticks as <cite/> text #2829

Closed
2 of 3 tasks
flying-sheep opened this issue Jan 25, 2024 · 1 comment · Fixed by tox-dev/sphinx-autodoc-typehints#422
Closed
2 of 3 tasks

Comments

@flying-sheep
Copy link
Member

flying-sheep commented Jan 25, 2024

Please make sure these conditions are met

  • I have checked that this issue has not already been reported.
  • I have confirmed this bug exists on the latest version of scanpy.
  • (optional) I have confirmed this bug exists on the master branch of scanpy.

What happened?

I expect <code/>, not <cite/>

grafik

It has nothing to do with our custom the following, I checked:

  1. scanpydoc
  2. our custom cite extension

I assume it’s MyST breaking default_role

Minimal code sample

Params
------
foo
	x `y` z

Error output

<dt>foo
<dd>x <cite>y</cite> z
@flying-sheep flying-sheep added this to the 1.10.0 milestone Jan 25, 2024
@flying-sheep flying-sheep changed the title Docs render text in backticks as <cite/> text Parameter docs render text in backticks as <cite/> text Jan 25, 2024
@flying-sheep
Copy link
Member Author

Fixed in sphinx-autodoc-typehints 1.25.3

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

Successfully merging a pull request may close this issue.

1 participant