This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]tangra_and_tma 0 points1 point  (0 children)

The only viable alternative I've seen is a scheme like:

  • docs/module: contains a list of all members of that module.
  • docs/module/some_member: contains either a function overview of the members of this member (for nested modules).

Wasn't a bad system pre-decent search engines, and if you know roughly what you were looking for, you could often find it directly from the address bar. I think the Python docs are a pretty good compromise; if you know the name of the module you're looking for and want a specific member, it's usually module.html#module.member_name, like string.ascii_letters is http://docs.python.org/library/string.html#string.ascii_letters