aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock/Options.hs
Commit message (Collapse)AuthorAgeFilesLines
* Let `haddock-test` bypass interface version check (#890)Alec Theriault2018-07-201-0/+3
| | | | | | | | | This means `haddock-test` might * crash during deserialization * deserialize incorrectly Still - it means things _might_ work where they were previously sure not to.
* @since includes package name (#749)Alec Theriault2018-03-271-2/+37
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Metadoc stores a package name This means that '@since' annotations can be package aware. * Get the package name the right way This should extract the package name for `@since` annotations the right way. I had to move `modulePackageInfo` around to do this and, in the process, I took the liberty to update it. Since it appears that finding the package name is something that can fail, I added a warning for this case. * Silence warnings * Hide package for local 'since' annotations As discussed, this is still the usual case (and we should avoid being noisy for it). Although this commit is large, it is basically only about threading a 'Maybe Package' from 'Haddock.render' all the way to 'Haddock.Backends.Xhtml.DocMarkup.renderMeta'. * Bump binary interface version * Add a '--since-qual' option This controls when to qualify since annotations with the package they come from. The default is always, but I've left an 'external' variant where only those annotations coming from outside of the current package are qualified. * Make ParserSpec work * Make Fixtures work * Use package name even if package version is not available The @since stuff needs only the package name passed in, so it makes sense to not be forced to pass in a version too.
* Add 'show' option to complement 'hide' (#752)Alec Theriault2018-02-111-0/+6
| | | | | | | | | | | | * Add 'show' option to complement 'hide' The behaviour is for flags passed in the command line to override flags in file headers. In the command line, later flags override earlier ones. Fixes #751 and #266. * Add a '--show-all' option
* Supported reexported-modules via --reexport flag.Edward Z. Yang2017-10-311-0/+7
| | | | Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>
* Put Quickjump behind --quickjump flag (#697)Alexander Biehl2017-10-301-0/+3
|
* Provide --show-interface option to dump interfaces (#645)Alexander Biehl2017-08-061-0/+6
| | | | | | | | | | | | | | | | | | | | | | * WIP: Provide --show-interface option to dump interfaces Like ghcs own --show-iface this flag dumps a binary interface file to stdout in a human (and machine) readable fashion. Currently it uses json as output format. * Fill all the jsonNull stubs * Rework Bifunctor instance of DocH, update changelog and documentation * replace changelog, bring DocMarkupH doc back * Update CHANGES.md * Update CHANGES.md * Move Control.Arrow up It would result in unused import if the Bifunctor instance is not generated.
* Fix the documentation for haddock itself.Dominic Steinitz2015-12-211-0/+7
| | | | | | | | | | | | | | | Change notation and add support for inline math. Allow newlines in display math. Add a command line option for the mathjax url (you might want to use a locally installed version). Rebase tests because of extra url and version change. Respond to (some of the) comments. Fix warnings in InterfaceFile.hs
* Add support for providing custom CSS files for hyperlinked source.Łukasz Hanuszczak2015-06-301-0/+6
|
* Add command line option for generating hyperlinked source.Łukasz Hanuszczak2015-06-301-0/+3
|
* --package-name and --package-version flagsMateusz Kowalczyk2015-01-221-8/+29
| | | | | | Used for --hoogle amongst other things. Now we need to teach cabal to use it. The situation is still a bit sub-par because if the flags aren't passed in, the crash will occur. Closes #353.
* Print missing docs by defaultMateusz Kowalczyk2014-12-181-3/+3
| | | | Adds --no-print-missing-docs
* Move sources under haddock-api/srcMateusz Kowalczyk2014-08-231-0/+287