| Commit message (Collapse) | Author | Age | Files | Lines |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This adds a new type of source code link, to a specific line rather than
a specific declaration/name - this is used to link to the location of a
TH splice that defines a certain name.
Rather hefty changes throughout and still one unresolved issue (the line
URLs aren't parsed from the third form of --read-interface which means
they're currently restricted to same-interface links). Not sure if
this issue is really worth all the hassle, especially since we could
just use line links in general.
This commit also contains some cleanup/clarification of the types in
Haddock.Backends.Xhtml.Decl and shortens some overlong lines in the
process. Notably, the Bool parameter was replaced by a Unicode type
synonym to help clarify its presence in type signatures.
|
|
|
|
|
|
| |
This lets you override them using eg. cabal haddock --haddock-options,
which can come in handy if you want to use a different layout or URL for
your source code links than cabal-install generates.
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Any extensions that are not enabled by a used language (Haskell2010
&c) will be shown. Furthermore, any implicitly enabled are also going
to be shown. While we could eliminate this either by using the GHC API
or a dirty hack, I opted not to: if a user doesn't want the implied
flags to show, they are recommended to use enable extensions more
carefully or individually. Perhaps this will encourage users to not
enable the most powerful flags needlessly. Enabled with show-extensions.
Conflicts:
src/Haddock/InterfaceFile.hs
|
| |
|
| |
|
| |
|
|
|
|
|
| |
Currently we ignore the package a module is imported from.
This means that a module import would shadow another one
with the same module name from a different package.
|
| |
|
|
|
|
|
| |
the user
and the actual qualification for a concrete module
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
|
|
| |
consistency
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
You can now use this flag like this:
--read-interface=<html path>,<source entity path>,<.haddock file>
By "source entity path" I mean the same thing that is specified with the
--source-entity flag. The purpose of this is to be able to specify the source
entity path per package, to allow source links to work in the presence of
cross-package documentation.
When given two arguments or less the --read-interface flag behaves as before.
|
| |
|
| |
|
|
|
|
|
|
|
|
|
|
| |
decided that --themes was silly - no one would do that, just use
multiple --theme arguments
made --theme a synonym for --css and -c
made those arguments, if no file is found, look up the argument as the
name of a built in theme
all of this let's haddock be invoked with "--theme=classic" for example.
|
|
|
|
|
|
|
| |
The bulk of the change is threadnig the selected theme set through functions
in Xhtml.hs so that the selected themes can be used when generating the page
output. There isn't much going on in most of these changes, just passing it
along. The real work is all done in Themes.hs.
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
|
|
|
|
|
| |
Determining the value of "singular" flags (by e.g. taking the last occurrence
of the flag) and other flag evaluation should done in Haddock.Options which is
the module that is supposed to define the command line interface. This makes
Main a bit easier on the eyes as well.
|
| |
|
|
|
|
|
| |
Also add a flag --no-tmp-comp-dir that can be used to get the old behaviour of
writing compilation files to GHC's output directory (default ".").
|
|
|
|
| |
Silly, but nice with some consistency :-)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
switch to using the xhtml package
copied Html.hs to Xhtml.hs
and split into sub-modules under Haddock/Backends/Xhtml
and detabify
moved footer into div, got ready for iface change
headers converted to semantic markup
contents in semantic markup
summary as semantic markup
description in semantic markup, info block in header fixed
factored out rendering so during debug it can be readable
(see renderToString)
|
| |
|
|
|
|
|
|
|
|
|
| |
Add a proper Haddock module header to each module, with a more finegrained
copyright. If you feel mis-accreditted, please correct any copyright notice!
The maintainer field is set to haddock@projects.haskell.org.
Next step is to add a brief description to each module.
|
|
|
|
| |
Only a few lines of code that mainly declares a type - why not just put it in Haddock.Types.
|
| |
|
| |
|
| |
|
| |
|
|
|
|
|
| |
The path can still be overridden using the -B flag. It's not longer
required to pass the lib dir to the program that runs the test suite.
|
| |
|
| |
|
| |
|