[haddock] #70: 'Contents' improvements based on Python's docs

haddock haddock at projects.haskell.org
Sat Jan 10 17:00:24 EST 2009


#70: 'Contents' improvements based on Python's docs
-------------------------------+--------------------------------------------
Reporter:  crutcher at gmail.com  |       Owner:       
    Type:  enhancement         |      Status:  new  
Priority:  major               |   Milestone:  2.5.0
 Version:                      |    Keywords:       
-------------------------------+--------------------------------------------
 Contrasting this page: http://haskell.org/ghc/docs/latest/html/libraries/

 With this one: http://docs.python.org/library/index.html

 We can see a number of ways to improve the library listings for haddock
 contents.

 First, there descriptions given to the libraries, rather than just their
 names.

 Second, the libraries themselves are grouped into type groups, above and
 beyond the lib paths themselves.

 Third, when you actually drill into a page a 'breadcrumb' is placed at the
 top of the page for navigating back out. Example, clicking on 'array'
 yields a page headed with:
   Python v2.6.1 documentation » The Python Standard Library » Data Types »

 These are 3 links, each stepping back up to a different containing level.

-- 
Ticket URL: <http://trac.haskell.org/haddock/ticket/70>
haddock <http://www.haskell.org/haddock>
Haddock, The Haskell Documentation Tool


More information about the Haddock mailing list