Skip to content

Commit

Permalink
DOC: Clearer attribute style (#6966)
Browse files Browse the repository at this point in the history
  • Loading branch information
larsoner committed Oct 18, 2019
1 parent 771e062 commit d88bd7c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
17 changes: 17 additions & 0 deletions doc/_static/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,27 @@ p code {
code.xref, a code {
font-weight: 600;
}
/* .. unless in a param list */
span.classifier a.reference code.literal {
font-weight: bold;
}
/* use semibold weight for version dropdown */
.btn {
font-weight: 600;
}
/* Modify our definition lists to be more like sklearn */
dl.field-list dt.field-odd, dt.field-even {
border-right-style: solid;
border-width: 1px;
border-color: var(--a-color-lighter);
}
dl.field-list dd dl dd {
padding-left: 30px;
}
dl.field-list dt, dd {
margin-top: 10px;
margin-bottom: 10px;
}

.navbar-version {
display: none;
Expand Down
3 changes: 2 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,7 @@ def reset_warnings(gallery_conf, fname):
'show_memory': True,
'line_numbers': False, # XXX currently (0.3.dev0) messes with style
'within_subsection_order': FileNameSortKey,
'capture_repr': (),
'junit': op.join('..', 'test-results', 'sphinx-gallery', 'junit.xml'),
}

Expand All @@ -522,7 +523,7 @@ def reset_warnings(gallery_conf, fname):
# XXX This hack defines what extra methods numpydoc will document
docscrape.ClassDoc.extra_public_methods = mne.utils._doc_special_members
numpydoc_class_members_toctree = False
numpydoc_attributes_as_param_list = False
numpydoc_attributes_as_param_list = True
numpydoc_xref_param_type = True
numpydoc_xref_aliases = {
'Popen': 'python:subprocess.Popen',
Expand Down

0 comments on commit d88bd7c

Please sign in to comment.