Hide descclassname in IPython docs ? #10660

Open
Carreau opened this Issue Jun 12, 2017 · 1 comment

Comments

Projects
None yet
2 participants
Owner

Carreau commented Jun 12, 2017

Sphinx by default show the fully qualified names of all objects, which is unnecessary as objects are in the current module you;re looking the docs for.

You can hide the name prefix with

code.descclassname {
    display: none;
    color: #AAA; /* change color  but you don't need to*/ 
}

dt:hover > code.descclassname {
   display: initial; /* reshow on hover  but you don't need to*/ 
}

That makes default page way easier to read (IMHO), so I'd like to have other thoughts.

@ellisonbg if you like that is it something that we might roll into the Jupyter Theme ?

lname

Owner

takluyver commented Jun 13, 2017

I think I'd find that width change on mouseover more annoying than the issue you're trying to fix.

The default Python docs make the class or function name bolder than the module name, which makes it easier to quickly spot those:

screenshot from 2017-06-13 10-53-37

The default RTD theme doesn't do that, unfortunately.

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