numpydoc icon indicating copy to clipboard operation
numpydoc copied to clipboard

Method names in Methods section

Open MSeifert04 opened this issue 9 years ago • 7 comments

The dev-version breaks the links I have in my Methods-section:

    Methods
    -------
    :py:meth:`~xxx.xxx`
        Some totally descriptive explanation.

I suspect it was #63 that broke this and it worked fine with 0.6.

MSeifert04 avatar Nov 08 '16 18:11 MSeifert04

Why is :py:meth: needed for you? That doesn't conform to the numpy docstring standard, so I'd like to at least understand before fixing it.

rgommers avatar Nov 10 '16 07:11 rgommers

If I just use methodname instead of :py:meth:´class.methodname´ it throws errors (I also get these errors with 0.6):

>>> python setup.py build_sphinx
...
reading sources... [100%] api/cls
WARNING: toctree references unknown document 'module.class.methodname'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] tipps
<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'module.class.methodname'
None:None: WARNING: toctree contains reference to nonexisting document 'module.class.methodname'
generating indices... genindex py-modindex
...

MSeifert04 avatar Nov 10 '16 10:11 MSeifert04

Weird, even though it constantly throws these Warnings - if I use just the methodname - the output looks ok. 😕

MSeifert04 avatar Nov 10 '16 10:11 MSeifert04

Interesting. Those warnings are very annoying, so would be good to fix those as well.

rgommers avatar Nov 11 '16 07:11 rgommers

@amueller @pv any opinion - revert the bold face for methods to support the :py:meth: usage or only remove the warnings?

Leaving bold face for attributes should be fine either way, and that was what gh-63 was concerned with.

rgommers avatar Nov 11 '16 07:11 rgommers

These warnings where there forever, right? that's #69.

amueller avatar Nov 11 '16 14:11 amueller

@amueller Thanks! Good to know there's a workaround! I'll give it a try.

MSeifert04 avatar Nov 12 '16 13:11 MSeifert04