Opened 8 years ago

Closed 7 years ago

#1639 enhancement closed fixed (fixed)

Full package and class hierarchy pages.

Reported by: jknight Owned by:
Priority: normal Milestone:
Component: pydoctor Keywords:
Cc: mwh, exarkun Branch:
Author: Launchpad Bug:

Description

People really seem to like to see hierarchies all on one page. In particular, the full module hierarchy of the old docs http://twisted.sourceforge.net/TwistedDocs-1.3.0rc1/api/index.html seems to be popular.

In addition, a new page showing a full class hierarchy would be a nice addition.

Change History (10)

comment:1 Changed 8 years ago by jknight

  • Cc mwh added
  • Owner changed from mwh to exarkun

Hm, nevermind, I see that's already been done, I was just looking at the wrong url. :)
http://starship.python.net/crew/mwh/apidocs3/moduleIndex.html

JP says he's going to update the twisted website to get these fancy new features, so I'll assign to him.

comment:2 Changed 8 years ago by mwh

Well, a minor thing is that these indices are currently not linked to from anywhere. I have some half-hearted changes towards making an index.html that links to these and the page for the twisted package in my wc, but they're not done yet.

comment:3 Changed 8 years ago by exarkun

  • Owner changed from exarkun to mwh

They're on the website now, at least. Re-assign to me when a version of pydoctor which will emit pages that link to them exists and I'll update it some more.

comment:4 Changed 8 years ago by mwh

  • Owner changed from mwh to exarkun

Take a look at this: http://starship.python.net/crew/mwh/apidocs/

pydoctor SVN has a few other fixes, so maybe now-ish would be a good time to update.

comment:5 Changed 8 years ago by mwh

  • Cc exarkun added

So, http://twistedmatrix.com/documents/current/api/index.html is still the same as http://twistedmatrix.com/documents/current/api/twisted.html, so the generated index.html is getting overriden. Can this be fixed?

comment:6 Changed 8 years ago by exarkun

The website deployment script includes this near the end:

ln -sf twisted.html api/index.html

I guess that's overriding it? I think this is done because there didn't use to be an index.html, but if there is one now I'll delete that line.

comment:7 Changed 8 years ago by mwh

Ah hah, that makes sense. If you like the generated index.html (as at http://just.acrate.de/crew/mwh/apidocs/) then, yeah, removing it would be the thing to do.

comment:8 Changed 8 years ago by exarkun

Nice

comment:9 Changed 7 years ago by exarkun

  • Resolution set to fixed
  • Status changed from new to closed

http://twistedmatrix.com/documents/current/api/moduleIndex.html exists now and is linked from the API index, so I guess this is done.

comment:10 Changed 3 years ago by <automation>

  • Owner exarkun deleted
Note: See TracTickets for help on using tickets.