Issue 5703: inside currentmodule some links is disabled (original) (raw)
This issue has been migrated to GitHub: https://github.com/python/cpython/issues/49953
classification
| Title: | inside *currentmodule* some links is disabled | ||
|---|---|---|---|
| Type: | Stage: | ||
| Components: | Documentation | Versions: | Python 3.0, Python 3.1, Python 2.7, Python 2.6 |
process
| Status: | closed | Resolution: | wont fix |
|---|---|---|---|
| Dependencies: | Superseder: | ||
| Assigned To: | georg.brandl | Nosy List: | georg.brandl, ocean-city |
| Priority: | normal | Keywords: |
Created on 2009-04-05 22:23 by ocean-city, last changed 2022-04-11 14:56 by admin. This issue is now closed.
| Messages (7) | ||
|---|---|---|
| msg85579 - (view) | Author: Hirokazu Yamamoto (ocean-city) *  |
Date: 2009-04-05 22:23 |
| 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? | ||
| msg85755 - (view) | Author: Georg Brandl (georg.brandl) * |
Date: 2009-04-07 22:54 |
| Since NonMultipart is in another module, it is not found automatically by unqualified name. This is working as expected. | ||
| msg85758 - (view) | Author: Hirokazu Yamamoto (ocean-city) * |
Date: 2009-04-07 23:56 |
| 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? | ||
| msg85918 - (view) | Author: Georg Brandl (georg.brandl) * |
Date: 2009-04-12 20:26 |
| 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". | ||
| msg85929 - (view) | Author: Hirokazu Yamamoto (ocean-city) * |
Date: 2009-04-12 23:59 |
| Thanks, I'll create the patch using this. | ||
| msg85930 - (view) | Author: Hirokazu Yamamoto (ocean-city) * |
Date: 2009-04-13 00:07 |
| 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....) | ||
| msg85937 - (view) | Author: Georg Brandl (georg.brandl) * |
Date: 2009-04-13 07:11 |
| If you want that level of control, it may be better to just write :meth:`Message.add_header() <email.message.Message.add_header>`. |
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022-04-11 14:56:47 | admin | set | github: 49953 |
| 2009-04-13 07:11:13 | georg.brandl | set | messages: + |
| 2009-04-13 00:07:44 | ocean-city | set | messages: + |
| 2009-04-12 23:59:42 | ocean-city | set | messages: + |
| 2009-04-12 20:26:30 | georg.brandl | set | messages: + |
| 2009-04-07 23:56:43 | ocean-city | set | messages: + |
| 2009-04-07 22:54:52 | georg.brandl | set | status: open -> closedresolution: wont fixmessages: + |
| 2009-04-05 22:23:59 | ocean-city | create |