This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author martin.panter
Recipients andymaier, docs@python, martin.panter
Date 2016-03-31.22:24:17
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1459463058.36.0.941112305855.issue26678@psf.upfronthosting.co.za>
In-reply-to
Content
Currently the “datetime” documentation has quick descriptions of classes marked up with “.. class::” in the introduction, and then dedicated sections with more details. Many other parts of Python’s documentation have a similar structure.

IMO it is better to include the “.. class::” markup closer to the list of methods, and then each method can be indented underneath it. See my changes to the “socketserver” documentation (Issue 15608, compare 3.4 vs 3.5) where I indented a whole lot of methods under class definitions. I suspect the reason why things are not like this is just that it is leftover from a conversion from an earlier markup format.

The earlier class introductions are also marked up with :noindex:, which would explain which become link targets.

Dunno about your intersphinx stuff though. Is that linking to the Python documentation from external projects?
History
Date User Action Args
2016-03-31 22:24:18martin.pantersetrecipients: + martin.panter, docs@python, andymaier
2016-03-31 22:24:18martin.pantersetmessageid: <1459463058.36.0.941112305855.issue26678@psf.upfronthosting.co.za>
2016-03-31 22:24:18martin.panterlinkissue26678 messages
2016-03-31 22:24:17martin.pantercreate