Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,6 @@ numpydoc_citation_re : str
should be mangled to avoid conflicts due to
duplication across the documentation. Defaults
to ``[\w-]+``.
numpydoc_use_blockquotes : bool
Until version 0.8, parameter definitions were shown as blockquotes, rather
than in a definition list. If your styling requires blockquotes, switch
this config option to True. This option will be removed in version 0.10.
numpydoc_attributes_as_param_list : bool
Whether to format the Attributes section of a class page in the same way
as the Parameter section. If it's False, the Attributes section will be
Expand Down
7 changes: 1 addition & 6 deletions numpydoc/docscrape_sphinx.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ def __init__(self, docstring, config=None):

def load_config(self, config):
self.use_plots = config.get("use_plots", False)
self.use_blockquotes = config.get("use_blockquotes", False)
self.class_members_toctree = config.get("class_members_toctree", True)
self.attributes_as_param_list = config.get("attributes_as_param_list", True)
self.xref_param_type = config.get("xref_param_type", False)
Expand Down Expand Up @@ -84,8 +83,6 @@ def _str_returns(self, name="Returns"):
if not param.desc:
out += self._str_indent([".."], 8)
else:
if self.use_blockquotes:
out += [""]
out += self._str_indent(param.desc, 8)
out += [""]
return out
Expand Down Expand Up @@ -217,9 +214,7 @@ def _str_param_list(self, name, fake_autosummary=False):
parts.append(param_type)
out += self._str_indent([" : ".join(parts)])

if desc and self.use_blockquotes:
out += [""]
elif not desc:
if not desc:
# empty definition
desc = [".."]
out += self._str_indent(desc, 8)
Expand Down
2 changes: 0 additions & 2 deletions numpydoc/numpydoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,6 @@ def mangle_docstrings(app, what, name, obj, options, lines):

cfg = {
"use_plots": app.config.numpydoc_use_plots,
"use_blockquotes": app.config.numpydoc_use_blockquotes,
"show_class_members": app.config.numpydoc_show_class_members,
"show_inherited_class_members": show_inherited_class_members,
"class_members_toctree": app.config.numpydoc_class_members_toctree,
Expand Down Expand Up @@ -274,7 +273,6 @@ def setup(app, get_doc_object_=get_doc_object):
app.connect("doctree-read", relabel_references)
app.connect("doctree-resolved", clean_backrefs)
app.add_config_value("numpydoc_use_plots", None, False)
app.add_config_value("numpydoc_use_blockquotes", None, False)
app.add_config_value("numpydoc_show_class_members", True, True)
app.add_config_value(
"numpydoc_show_inherited_class_members", True, True, types=(bool, dict)
Expand Down
46 changes: 0 additions & 46 deletions numpydoc/tests/test_docscrape.py
Original file line number Diff line number Diff line change
Expand Up @@ -1059,52 +1059,6 @@ def test_plot_examples():
assert str(doc).count("plot::") == 1, str(doc)


def test_use_blockquotes():
cfg = dict(use_blockquotes=True)
doc = SphinxDocString(
"""
Parameters
----------
abc : def
ghi
jkl
mno

Returns
-------
ABC : DEF
GHI
JKL
MNO
""",
config=cfg,
)
line_by_line_compare(
str(doc),
"""
:Parameters:

**abc** : def

ghi

**jkl**

mno

:Returns:

**ABC** : DEF

GHI

JKL

MNO
""",
)


def test_class_members():
class Dummy:
"""
Expand Down
1 change: 0 additions & 1 deletion numpydoc/tests/test_numpydoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@

class MockConfig:
numpydoc_use_plots = False
numpydoc_use_blockquotes = True
numpydoc_show_class_members = True
numpydoc_show_inherited_class_members = True
numpydoc_class_members_toctree = True
Expand Down