inside *currentmodule* some links is disabled

[ocean-city]

BPO	5703
Nosy	@birkenfeld

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2009-04-07.22:54:52.775>
created_at = <Date 2009-04-05.22:23:59.289>
labels = ['docs']
title = 'inside *currentmodule* some links is disabled'
updated_at = <Date 2009-04-13.07:11:13.212>
user = 'https://bugs.python.org/ocean-city'

bugs.python.org fields:

activity = <Date 2009-04-13.07:11:13.212>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2009-04-07.22:54:52.775>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2009-04-05.22:23:59.289>
creator = 'ocean-city'
dependencies = []
files = []
hgrepos = []
issue_num = 5703
keywords = []
message_count = 7.0
messages = ['85579', '85755', '85758', '85918', '85929', '85930', '85937']
nosy_count = 2.0
nosy_names = ['georg.brandl', 'ocean-city']
pr_nums = []
priority = 'normal'
resolution = 'wont fix'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue5703'
versions = ['Python 2.6', 'Python 3.0', 'Python 3.1', 'Python 2.7']

[ocean-city]

See http://docs.python.org/library/email.mime.html

Inside MIMEApplication documentation, link to MIMEApplication is enabled
but link to MIMENonMultipart is disabled. This happens because
MIMENonMultipart is not in email.mime.application (specified by
currentmodule directive). Is this sphinx bug? Or should MIMENonMultipart
be written in full name like email.mime.nonmultipart.MIMENonMultipart?

[birkenfeld]

Since NonMultipart is in another module, it is not found automatically
by unqualified name. This is working as expected.

[ocean-city]

Sorry, I shouldn't call this a bug. Rather I should use the word
"proposal". I think a link to MIMENonMultipart is also useful. What I
can imagine how to achieve this is...

1. Rewrite MIMENonMultipart to email.mime.MIMENonMultipart
2. Introduce something new directive to sphinx? Like :class<email.mime>:
3. When class is not found in current module, search in document global
   module.

How do you think?

[birkenfeld]

You can write :class:`~email.mime.MIMENonMultipart`; this will link to
the correct class but only display the thing after the last dot, in this
case "MIMENonMultipart".

[ocean-city]

Thanks, I'll create the patch using this.

[ocean-city]

I noticed :meth:`~email.message.Message.add_header` renders "add_header"
but maybe "Message.add_header" is better? (Maybe sphinx tracker is
suitable for now....)

[birkenfeld]

If you want that level of control, it may be better to just write
:meth:`Message.add_header() <email.message.Message.add_header>`.