torproject / stem

Python controller library for Tor
https://stem.torproject.org/
GNU Lesser General Public License v3.0
260 stars 75 forks source link

Module overview interlinking #36

Open atagar opened 4 years ago

atagar commented 4 years ago

Migrated from ticket 7632.

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

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