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

Definition list produced by option directive styled incorrectly #1081

Open
madjxatw opened this issue Mar 12, 2021 · 4 comments
Open

Definition list produced by option directive styled incorrectly #1081

madjxatw opened this issue Mar 12, 2021 · 4 comments
Labels
Improvement Minor improvement to code Needed: patch A pull request is required

Comments

@madjxatw
Copy link

Problem

#838 fixed a bunch of issues about definition list (dl) with Sphinx 2, the simple definition list, option list, glossary terms are all styled correctly now, but the dl produced by the option directive seems still incorrect.

2021-03-12-223916_407x593_scrot

It should be styled as same as option list.

Environment Info

  • Python Version: 3.9.1
  • Sphinx Version: 3.5.1
  • RTD Theme Version: 0.5.1
@madjxatw madjxatw added Bug A bug Needed: replication Bug replication is required labels Mar 12, 2021
@Blendify
Copy link
Member

By option do you mean .. option::?

@madjxatw
Copy link
Author

@Blendify, exactly.

@Blendify
Copy link
Member

Blendify commented Mar 12, 2021

Technically, .. option:: is part of the reStructuredText domain which is different than an option list so it makes to style similar to the rest of the API domains. Maybe here we should make an expectation and style them differently. Something like this perhaps?

image

@Blendify Blendify added Improvement Minor improvement to code Needed: patch A pull request is required and removed Bug A bug Needed: replication Bug replication is required labels Mar 12, 2021
@madjxatw
Copy link
Author

It looks better than the one I posted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: patch A pull request is required
Projects
None yet
Development

No branches or pull requests

2 participants