Skip to content
Snippets Groups Projects
Commit b7cf87b6 authored by Philipp Arras's avatar Philipp Arras
Browse files

Activate special docs

parent 7f15d17f
No related branches found
No related tags found
No related merge requests found
...@@ -379,7 +379,7 @@ Minimization algorithms ...@@ -379,7 +379,7 @@ Minimization algorithms
All minimization algorithms in NIFTy inherit from the abstract All minimization algorithms in NIFTy inherit from the abstract
:class:`~minimizer.Minimizer` class, which presents a minimalistic interface :class:`~minimizer.Minimizer` class, which presents a minimalistic interface
consisting only of a :meth:`~minimizer.Minimizer.__call__()` *FIXME* method taking an consisting only of a :meth:`~minimizer.Minimizer.__call__()` method taking an
:class:`~energy.Energy` object and optionally a preconditioning operator, and :class:`~energy.Energy` object and optionally a preconditioning operator, and
returning the energy at the discovered minimum and a status code. returning the energy at the discovered minimum and a status code.
......
...@@ -13,6 +13,7 @@ napoleon_use_ivar = True ...@@ -13,6 +13,7 @@ napoleon_use_ivar = True
napoleon_use_admonition_for_notes = True napoleon_use_admonition_for_notes = True
napoleon_use_admonition_for_examples = True napoleon_use_admonition_for_examples = True
napoleon_use_admonition_for_references = True napoleon_use_admonition_for_references = True
napoleon_include_special_with_doc = True
project = u'NIFTy5' project = u'NIFTy5'
copyright = u'2013-2019, Max-Planck-Society' copyright = u'2013-2019, Max-Planck-Society'
......
...@@ -21,7 +21,6 @@ from ..utilities import NiftyMeta ...@@ -21,7 +21,6 @@ from ..utilities import NiftyMeta
class Minimizer(metaclass=NiftyMeta): class Minimizer(metaclass=NiftyMeta):
"""A base class used by all minimizers.""" """A base class used by all minimizers."""
# MR FIXME: the docstring is partially ignored by Sphinx. Why?
def __call__(self, energy, preconditioner=None): def __call__(self, energy, preconditioner=None):
"""Performs the minimization of the provided Energy functional. """Performs the minimization of the provided Energy functional.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment