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

List of parameters overflows 'Parameter:' in Alabaster theme when napoleon 'Returns:' statement spans two or more lines #3276

Closed
benjaminweb opened this issue Dec 23, 2016 · 5 comments
Assignees

Comments

@benjaminweb
Copy link

Problem

See how the list of parameters overflows 'Parameters:' caption.

sepcaus

That occurs when 'Returns:' or 'Raises:' (sphinx.ext.napoleon) spans on multiple lines.
It starts with two lines to occur. The left-indent increases with each subsequent line.

Procedure to reproduce the problem

  $ unzip alabaster.zip # see below for attached file
  $ cd albaster/doc
  $ make html
  $ open _build/html/index.html

Expected results

The list of parameters should begin after the colon of 'Parameters:' like here:

decimal_gcd

Reproducible project / your project

See alabaster.zip.

Environment info

  • OS: Mac OS X El Capitain 10.11.6 (15G1212)
  • Python version: 3.5.2
  • Sphinx version: 1.4.9+
  • Used extensions: sphinx.ext.autodoc, sphinx.ext.napeleon
@RobRuana RobRuana self-assigned this Dec 23, 2016
@RobRuana
Copy link
Contributor

Thanks for the report! I'm looking into it!

@RobRuana
Copy link
Contributor

It looks like this issue is a direct result of this pull request, because the <th> element is inheriting its hyphens attribute from its parent <dd> element.

Does anyone object to me adding a more specific rule in basic.css to fix this issue for field names?

Something like this: (manual is the default value for hyphens)

.field-name {
    -moz-hyphens: manual;
    -ms-hyphens: manual;
    -webkit-hyphens: manual;
    hyphens: manual;
}

@RobRuana
Copy link
Contributor

As an aside, thank you for the excellent bug report. Very clear, plus included a reproducible product! Excellent!

@benjaminweb
Copy link
Author

@RobRuana Thanks for your timely fix. I confirm the complete resolution of the reported problem.

@bitprophet
Copy link
Contributor

Belatedly, I just ran into this (was tracking under sphinx-doc/alabaster#95) and independently confirmed the same cause/effect. 👍

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 31, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants