Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Method names in Methods section #74

Open
MSeifert04 opened this issue Nov 8, 2016 · 7 comments
Open

Method names in Methods section #74

MSeifert04 opened this issue Nov 8, 2016 · 7 comments

Comments

@MSeifert04
Copy link
Contributor

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.

@rgommers rgommers added this to the v0.7.0 milestone Nov 10, 2016
@rgommers
Copy link
Member

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.

@MSeifert04
Copy link
Contributor Author

MSeifert04 commented Nov 10, 2016

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
Copy link
Contributor Author

MSeifert04 commented Nov 10, 2016

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

@rgommers
Copy link
Member

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

@rgommers
Copy link
Member

@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.

@amueller
Copy link
Contributor

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

@MSeifert04
Copy link
Contributor Author

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

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

No branches or pull requests

3 participants