| Commit message (Collapse) | Author | Age | Files | Lines |
... | |
|
|
|
|
|
| |
When the path ends in a file seperator there is no need to add another.
Now using "--wiki=http://blah.com/foo/" should do the right thing.
(Code snippet adapted from Isaac's FilePath package.)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
In each module, for each "top level" exported entity we add a hyper link to a
corresponding wiki page. The link url gets the name of the exported entity as
a '#'-style anchor, so if there is an anchor in the page with that name then
the users browser should jump directly to it. By "top level" we mean functions,
classes, class members and data types (data, type, newtype), but not data
constructors, class instances or data type class membership.
The link is added at the right of the page and in a small font. Hopefully this
is the right balance of visibility/distraction.
We also include a link to the wiki base url in the contents and index pages.
|
|
|
|
|
|
|
|
| |
So each html page gets an extra link (placed next to the source code and
contents links) to a corresponding wiki page. The idea is to let readers
contribute their own notes, examples etc to the documentation.
Also slightly tidy up the code for the --source option.
|
| |
|
|
|
|
|
|
| |
extractRecSel: ignore non-record constructors (fixes a crash when
using datatypes with a mixture of record and non-record style
constructors).
|
|
|
|
| |
replace mingw tests with $(Windows)
|
|
|
|
|
|
| |
name hierarchical HTML files as A-B-C.html instead of A.B.C.html. The
old way confused Apache because the extensions are sometimes
interpreted as having special meanings.
|
|
|
|
| |
wibble
|
|
|
|
| |
Allow "licence" as an alternate spelling of "license"
|
|
|
|
| |
Warning/versionitis police
|
|
|
|
| |
fix 3 bugs in --use-package, and document it.
|
|
|
|
|
| |
Hack haddock's lexer to accept the output from Apple's broken version of
cpp (Apple's cpp leaves #pragma set_debug_pwd directives in it's output).
|
|
|
|
|
|
| |
Another attempt at lining up the package names on the contents page.
Now, they line up with Konqueror, and almost line up with Firefox & IE
(different layout in each case).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Attempt to fix the layout of the package names in the contents.
Having tried just about everything, the only thing I can get to work
reliably is to make the package names line up on a fixed offset from
the left margin. This obviously isn't ideal, so anyone else that
would like to have a go at improving it is welcome. One option is to
remove the +/- buttons from the contents list and go back to a plain
table.
The contents page now uses CSS for layout rather than tables. It
seems that most browsers have different interpretations of CSS layout,
so only the simplest things lead to consistent results.
|
|
|
|
|
|
|
| |
sort lists of instances by
- arity of the type constructors (so higher-kinded instances come first)
- name of the class
- argument types
|
|
|
|
|
|
| |
Add attribute #not-home, to indicate that the current module should
not be considered to be a home module for the each entity it exports,
unless there is no other module that exports the entity.
|
|
|
|
|
| |
Fix bug in renameExportItems that meant links in instances weren't
being renamed properly.
|
|
|
|
| |
fix typo for < 6.3
|
|
|
|
|
|
|
|
|
|
|
|
| |
- add --ignore-all-exports flag, which behaves as if every module
has the ignore-exports attribute (requested by Chris Ryder).
- add --hide option to hide a module on the command line.
- add --use-package option to get Haddock info for a package from
ghc-pkg (largely untested).
- remove reexports from the .haddock file, they aren't used any more.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Revamp the linking strategy in Haddock.
Now name resolution is done in two phases:
- first resolve everything to original names, like a Haskell compiler
would.
- then, figure out the "home" location for every entity, and point
all the links to there. The home location is the lowest non-hidden
module in the import hierarchy that documents the entity. If there
are multiple candidates, one is chosen at random.
Also:
- Haddock should not generate any HTML with dangling links any more.
Unlinked references are just rendered as plain text.
- Error reporting is better: if we can't find a link destination for
an entity reference, we now emit a warning.
|
|
|
|
| |
import Foreign/Foreign.C are required for Windows
|
|
|
|
| |
Cleaned up imports and dropped support for GHC < 5.03, it never worked, anyway.
|
|
|
|
| |
Refactored Text.PrettyPrint legacy hell into a separate module.
|
|
|
|
| |
Added the last missing "flip" to get identical HTML output as previous versions.
|
|
|
|
| |
Data.Map.unions is left-biased.
|
|
|
|
|
| |
Correctly handle the new order of arguments for the combining function
given to fromListWith.
|
|
|
|
| |
Trim imports
|
|
|
|
|
|
|
|
|
|
| |
Make Haddock compile again after the recent base package changed. The Map/Set
legacy hell has been factored out, so that all modules can simply use the new
non-deprecated interfaces. Probably a lot of things can be improved by a little
bit of Map/Set/List algebra, this can be done later if needed.
Small note: Currently the list of instances in HTML code is reversed. This will
hopefully be fixed later.
|
|
|
|
| |
also allow uppercase X in hexadecimal character references (like SGML)
|
|
|
|
|
| |
recognize SGML-style numeric character references &#ddd; or &#xhhhh; and
translate them into Chars.
|
|
|
|
| |
Remove string gap
|
|
|
|
|
|
|
|
|
|
| |
Render non-ASCII characters using numeric character references, to simplify
charset issues. There's a META tag saying the charset is UTF-8, but GHC
outputs characters as raw bytes.
Ideally we need an encoding on the input side too, primarily in comments,
because source files containing non-ASCII characters aren't portable between
locales.
|
|
|
|
| |
parser fix: allow qualified specialids.
|
|
|
|
| |
Revert previous commit: It's Network.URI which should be changed, not Haddock.
|
|
|
|
| |
update for ghc-6.3+
|
|
|
|
|
| |
Improved the Cygwin/MinGW chaos a little bit. There is still confusion
about host platform vs. target platform...
|
|
|
|
|
|
|
|
| |
Switched the default state for instances and the module hierarchy to
non-collapsed. This can be reversed when we finally use cookies from
JavaScript to have a more persistent state. Previously going back and forth
in the documentation was simply too annoying because everything was
collapsed again and therefore the documentation was not easily navigatable.
|
|
|
|
| |
Avoid GHC/shell versionitis and create Version.hs
|
|
|
|
| |
escape HADDOCK_VERSION double quotes on all platforms when compiling with <=6.0.x
|
|
|
|
|
|
|
|
| |
SGML is dead, long live DocBook XML!
Note: The BuildRequires tags in the spec files are still incomplete
and the documentation about the DocBook tools needs to be updated,
too. Stay tuned...
|
|
|
|
| |
backquote HADDOCK_VERSION defn for <= ghc-6.0.x; believe this is only needed under mingw
|
|
|
|
| |
Avoid using string-gap tricks.
|
|
|
|
| |
Fixes to installation under Windows.
|
|
|
|
| |
Fixes for DevHelp/HtmlHelp following introduction of short module description.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Add support for a short description for each module, which is included
in the contents.
The short description should be given in a "Description: " field of
the header. Included in this patch are changes that make the format
of the header a little more flexible. From the comments:
-- all fields in the header are optional and have the form
--
-- [spaces1][field name][spaces] ":"
-- [text]"\n" ([spaces2][space][text]"\n" | [spaces]"\n")*
-- where each [spaces2] should have [spaces1] as a prefix.
--
-- Thus for the key "Description",
--
-- > Description : this is a
-- > rather long
-- >
-- > description
-- >
-- > The module comment starts here
--
-- the value will be "this is a .. description" and the rest will begin
-- at "The module comment".
The header fields must be in the following order: Module, Description,
Copyright, License, Maintainer, Stability, Portability.
Patches submitted by: George Russell <ger@informatik.uni-bremen.de>,
with a few small changes be me, mostly to merge with other recent
changes.
ToDo: document the module header.
|
|
|
|
|
|
| |
Add FormatVersion
Patch submitted by: George Russell <ger@informatik.uni-bremen.de>
|
|
|
|
| |
Improved spacing of dynamic module tree
|
|
|
|
| |
ffi wibble
|
|
|
|
| |
make it compile with <= ghc-6.1
|
|
|
|
|
|
|
|
|
|
| |
Pacify W3C validator:
* Added document encoding (currently UTF-8, not sure if this is completely correct)
* Fixed syntax of `id' attributes
* Added necessary `alt' attribute for +/- images
Small layout improvement:
* Added space after +/- images (still not perfect, but better than before)
|