Opened 5 years ago

Last modified 4 years ago

#7632 new enhancement

Module overview interlinking

Reported by: atagar Owned by: atagar
Priority: High Milestone:
Component: Core Tor/Stem Version:
Severity: Keywords: website
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

Presently we're including a summary for modules at the top of their page. These summaries include classes, methods, and show their inheritance/membership. For instance...

https://stem.readthedocs.org/en/latest/api/control.html

This is fine and well, but I'm doing it via a preformatted text block to take advantage of the monospaced text to show membership. This is a hack, and doing it this way means that we can't include links to the class/method documentation.

We should check to see if there's a better way of doing module overviews, maybe asking on the sphinx list.

Child Tickets

Change History (3)

comment:1 Changed 5 years ago by atagar

I sent an email to sphinx-users@ asking for advice on this but the moderator's being unresponsive. Filed a ticket to hopefully move things along (link).

comment:2 Changed 5 years ago by atagar

My sphinx-users@ question finally got approved but no luck getting a reply. The next person to pick up this task should try again, possibly referencing my post.

comment:3 Changed 4 years ago by atagar

Priority: normalmajor
Note: See TracTickets for help on using tickets.