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 lists are squashed together now #95

Closed
bitprophet opened this issue Jan 12, 2017 · 4 comments
Closed

Parameter lists are squashed together now #95

bitprophet opened this issue Jan 12, 2017 · 4 comments
Labels

Comments

@bitprophet
Copy link
Collaborator

Not sure if this is a change we made or something made in base Sphinx somewhere (?!) but at some point I noticed parameter lists get nastily crammed together and it looks awful:

screen shot 2017-01-12 at 2 45 14 pm

The actual param (which is into but you can't even tell that) is super overlapping, and the Returns bit is not quite overlapping but nearly so, definitely more than it should.

This output came from master Alabaster on Sphinx 1.4.5.

Honestly surprised nobody else has reported this yet (at least, I can't find another report); either it's due to an unreleased change or just a recent one & most folks are using the version pinned inside Sphinx itself.

@bitprophet bitprophet added the bug label Jan 12, 2017
@bitprophet
Copy link
Collaborator Author

bitprophet commented Jan 12, 2017

Yea, reverting to pip install 'sphinx<1.4' (gets me 1.3.6) makes this problem go away completely:

screen shot 2017-01-12 at 2 49 10 pm

Confirmed also that even Sphinx e.g. 1.4.1 causes the issue, so it was almost certainly a 1.4 related issue and not a later regression.

And that latest Sphinx 1.4 (1.4.9) still has the issue.

@bitprophet
Copy link
Collaborator Author

bitprophet commented Jan 12, 2017

Diff of basic.css output between 1.3.6 and 1.4.9 has nothing super obviously related but I haven't really poked yet:

--- _build-1.3.6/_static/basic.css	2017-01-12 14:50:36.000000000 -0800
+++ _build-1.4.9/_static/basic.css	2017-01-12 14:51:27.000000000 -0800
@@ -45,20 +45,22 @@
 
 div.sphinxsidebarwrapper {
     padding: 10px 5px 0 10px;
 }
 
 div.sphinxsidebar {
     float: left;
     width: 230px;
     margin-left: -100%;
     font-size: 90%;
+    word-wrap: break-word;
+    overflow-wrap : break-word;
 }
 
 div.sphinxsidebar ul {
     list-style: none;
 }
 
 div.sphinxsidebar ul ul,
 div.sphinxsidebar ul.want-points {
     margin-left: 20px;
     list-style: square;
@@ -76,24 +78,20 @@
 div.sphinxsidebar input {
     border: 1px solid #98dbcc;
     font-family: sans-serif;
     font-size: 1em;
 }
 
 div.sphinxsidebar #searchbox input[type="text"] {
     width: 170px;
 }
 
-div.sphinxsidebar #searchbox input[type="submit"] {
-    width: 30px;
-}
-
 img {
     border: 0;
     max-width: 100%;
 }
 
 /* -- search page ----------------------------------------------------------- */
 
 ul.search {
     margin: 10px 0 0 20px;
     padding: 0;
@@ -180,20 +178,27 @@
 
 div.genindex-jumpbox {
     border-top: 1px solid #ddd;
     border-bottom: 1px solid #ddd;
     margin: 1em 0 1em 0;
     padding: 0.4em;
 }
 
 /* -- general body styles --------------------------------------------------- */
 
+div.body p, div.body dd, div.body li, div.body blockquote {
+    -moz-hyphens: auto;
+    -ms-hyphens: auto;
+    -webkit-hyphens: auto;
+    hyphens: auto;
+}
+
 a.headerlink {
     visibility: hidden;
 }
 
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
 h4:hover > a.headerlink,
 h5:hover > a.headerlink,
 h6:hover > a.headerlink,
@@ -482,20 +487,27 @@
     cursor: help;
 }
 
 /* -- code displays --------------------------------------------------------- */
 
 pre {
     overflow: auto;
     overflow-y: hidden;  /* fixes display issues on Chrome browsers */
 }
 
+span.pre {
+    -moz-hyphens: none;
+    -ms-hyphens: none;
+    -webkit-hyphens: none;
+    hyphens: none;
+}
+
 td.linenos pre {
     padding: 5px 0px;
     border: 0;
     background-color: transparent;
     color: #aaa;
 }
 
 table.highlighttable {
     margin-left: 0.5em;
 }

@bitprophet
Copy link
Collaborator Author

Huh, I was wrong. It's simply hyphens: auto (at least, in Chrome, which I neglected to note is what I am using.) Toggling that off in dev console and poof, much much better.

Time to track down why that was added in the first place and see if us manually overriding it is likely to piss anyone off.

@bitprophet
Copy link
Collaborator Author

Turns out parent was tracking this after all, hooray. Fix already merged to their master, though it's unclear if the 1.4 line is still slated to get bugfix releases or what. I'll probably just rub it on our own stylesheets so myself and others on 1.4.x don't suffer.

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

No branches or pull requests

1 participant