aboutsummaryrefslogtreecommitdiff
path: root/haddock-api
Commit message (Collapse)AuthorAgeFilesLines
...
| | | * | Fix crash when there are no srcspans in the file due to CPPZubin Duggal2019-10-072-9/+12
| | | | |
| | | * | Fix the ignore-exports option (#1082)Alexis King2019-09-301-4/+5
| | | | | | | | | | | | | | | The `ignore-exports` option has been broken since #688, as mentioned in https://github.com/haskell/haddock/pull/766#issue-172505043. This PR fixes it.
| | | * | Fix Travis CI, loosen .cabal bounds (#1089)Alec Theriault2019-09-201-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Tentatively for the 2.23 release: * updated Travis CI to work again * tweaked bounds in the `.cabal` files * adjusted `extra-source-files` to properly identify test files
| | | * | update for new way to store hiefile headersZubin Duggal2019-06-041-2/+3
| | | | |
| | | * | Release haddock-2.23, haddock-library-1.8.0Alec Theriault2019-05-261-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | Tentatively adjust bounds and changelogs for the release to be bundled with GHC 8.8.1.
| | | * | Remove Haddock's dependency on `Cabal`Alec Theriault2019-05-264-11/+22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | At this point, Haddock depended on Cabal-the-library solely for a verbosity parser (which misleadingly accepts all sorts of verbosity options that Haddock never uses). Now, the only dependency on Cabal is for `haddock-test` (which uses Cabal to locate the Haddock interface files of a couple boot libraries).
| | | * | Fix #1063 with better parenthesization logic for contextsAlec Theriault2019-05-171-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The only other change in html/hoogle/hyperlinker output for the boot libraries that this caused is a fix to some Hoogle output for implicit params. ``` $ diff -r _build/docs/ old_docs diff -r _build/docs/html/libraries/base/base.txt old_docs/html/libraries/base/base.txt 13296c13296 < assertError :: (?callStack :: CallStack) => Bool -> a -> a --- > assertError :: ?callStack :: CallStack => Bool -> a -> a ```
| | | * | Comment C, which clarifies why e.g. ReadP is not enoughOleg Grenrus2019-05-131-0/+7
| | | | |
| | | * | Redo ParseModuleHeaderOleg Grenrus2019-05-131-93/+125
| | | | |
| | | * | Remove outdated `.ghci` files and `scripts`Alec Theriault2019-05-131-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | The `.ghci` files are actively annoying when trying to `cabal v2-repl`. As for the `scripts`, the distribution workflow is completely different.
| | | * | Bump GHC to 8.8Ben Gamari2019-03-291-2/+2
| | | | |
| | | * | Matching changes in GHC for #16236Alan Zimmerman2019-03-294-10/+10
| | | | | | | | | | | | | | | | | | | | (cherry picked from commit 3ee6526d4ae7bf4deb7cd1caf24b3d7355573576)
| | | * | Remove workaround for now-fixed Clang CPP bug (#1028)Alec Theriault2019-03-294-81/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Before LLVM 6.0.1 (or 10.0 on Apple LLVM), there was a bug where lines that started with an octothorpe but turned out not to lex like pragmas would have an extra line added after them. Since this bug has been fixed upstream and that it doesn't have dire consequences anyways, the workaround is not really worth it anymore - we can just tell people to update their clang version (or re-structure their pragma code).
| | | * | Many LaTeX backend fixesAlec Theriault2019-03-091-98/+118
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | After this commit, we can run with `--latex` on all boot libraries without crashing (although the generated LaTeX still fails to compile in a handful of larger packages like `ghc` and `base`). * Add newlines after all block elements in LaTeX. This is important to prevent the final output from being more an more indented. See the `latext-test/src/Example` test case for a sample of this. * Support associated types in class declarations (but not yet defaults) * Several small issues for producing compiling LaTeX; - avoid empy `\haddockbeginargs` lists (ex: `type family Any`) - properly escape identifiers depending on context (ex: `Int#`) - add `vbox` around `itemize`/`enumerate` (so they can be in tables) * Several spacing fixes: - limit the width of `Pretty`-arranged monospaced code - cut out extra space characters in export lists - only escape spaces if there are _multiple_ spaces - allow type signatures to be multiline (even without docs) * Remove uninteresting and repetitive `main.tex`/`haddock.sty` files from `latex-test` test reference output. Fixes #935, #929 (LaTeX docs for `text` build & compile) Fixes #727, #930 (I think both are really about type families...)
| | | * | Avoid multi-line `emph` in LaTeX backendAlec Theriault2019-03-091-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | `markupWarning` often processes inputs which span across paragraphs. Unfortunately, LaTeX's `emph` is not made to handle this (and will crash). Fixes #936.
| | | * | Better support for default methods in classesAlec Theriault2019-03-094-51/+102
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * default methods now get rendered differently * default associated types get rendered * fix a forgotten `s/TypeSig/ClassOpSig/` refactor in LaTeX backend * LaTeX backend now renders default method signatures NB: there is still no way to document default class members and the NB: LaTeX backend still crashes on associated types
| | | * | Merge branch 'ghc-8.6' into ghc-8.8Alec Theriault2019-03-0318-321/+734
| | | |\ \
| | | | * | Increase contrast of Linuwal theme (#1037)gbaz2019-03-011-4/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is to address the concern that, on less nice and older screens, some of the shades of grey blend in too easily with the white background. * darken the font slightly * darken slightly the grey behind type signatures and such * add a border and round the corners on code blocks * knock the font down by one point
| | | | * | `--show-interface` should output to stdout. (#1040)Alec Theriault2019-02-281-1/+2
| | | | | | | | | | | | | | | | | | Fixes #864.
| | | | * | Menu item controlling which instances are expanded/collapsed (#1007)Xia Li-yao2019-02-278-229/+635
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Adds a menu item (like "Quick Jump") for options related to displaying instances. This provides functionality for: * expanding/collapsing all instances on the currently opened page * controlling whether instances are expanded/collapsed by default * controlling whether the state of instances should be "remembered" This new functionality is implemented in Typescript in `details-helper`. The built-in-themes style switcher also got a revamp so that all three of QuickJump, the style switcher, and instance preferences now have the same style and implementation structure. See also: https://mail.haskell.org/pipermail/haskell-cafe/2019-January/130495.html Fixes #698. Co-authored-by: Lysxia <lysxia@gmail.com> Co-authored-by: Nathan Collins <conathan@galois.com>
| | | | * | Fix standalone deriving docsAlec Theriault2019-02-251-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Docs on standalone deriving decls for classes with associated types should be associated with the class instance, not the associated type instance. Fixes #1033
| | | | * | Loosen 'QuickCheck' and 'hspec' boundsAlec Theriault2019-01-281-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It looks like the new versions don't cause any breakage and loosening the bounds helps deps fit in one stack resolver.
| | | | * | Fix #1004 with a pinch of dropForAllsRyan Scott2019-01-271-1/+1
| | | | | |
| | | | * | Keep forall on H98 existential data constructors (#1003)Alec Theriault2019-01-232-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The information about whether or not there is a source-level `forall` is already available on a `ConDecl` (as `con_forall`), so we should use it instead of always assuming `False`! Fixes #1002.
| | | | * | Print kinded tyvars in constructors for Hoogle (#993)Alec Theriault2019-01-071-2/+8
| | | | | | | | | | | | | | | | | | Fixes #992
| | | | * | Load plugins when compiling each module (#983)Alec Theriault2018-12-202-6/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * WIP: Load (typechecker) plugins from language pragmas * Revert "Load plugins when starting a GHC session (#905)" This reverts commit 72d82e52f2a6225686d9668790ac33c1d1743193. * Simplify plugin initialization code
| | | | * | More uniform handling of `forall`'s in HTML/LaTeXAlec Theriault2018-11-262-60/+50
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * don't forget to print explicit `forall`'s when there are arg docs * when printing an explicit `forall`, print all tyvars Fixes #973
| | | | * | Add blockquote stylingAlec Theriault2018-11-121-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Matches b71da1feabf33efbbc517ac376bb690b5a604c2f from hackage-server. Fixes #967.
| | | | * | Rename 'NewOcean' theme to 'Linuwial'Alec Theriault2018-11-114-3/+3
| | | | | |
| | | * | | Fix bogus identifier defaultingAlec Theriault2019-02-261-9/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This avoids a situation in which an identifier would get defaulted to a completely different identifier. Prior to this commit, the 'Bug1035' test case would hyperlink 'Foo' into 'Bar'! Fixes #1035.
| | | * | | Better identifier parsingAlec Theriault2019-02-2511-66/+142
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * '(<|>)' and '`elem`' now get parsed and rendered properly as links * 'DbModule'/'DbUnitId' now properly get split apart into two links * tuple names now get parsed properly * some more small niceties... The identifier parsing code is more precise and more efficient (although to be fair: it is also longer and in its own module). On the rendering side, we need to pipe through information about backticks/parens/neither all the way through from renaming to the backends. In terms of impact: a total of 35 modules in the entirety of the bootlib + ghc lib docs change. The only "regression" is things like '\0'. These should be changed to @\\0@ (the path by which this previously worked seems accidental).
| | | * | | Support value/type namespaces on identifier linksAlec Theriault2019-02-255-22/+58
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Identifier links can be prefixed with a 'v' or 't' to indicate the value or type namespace of the desired identifier. For example: -- | Some link to a value: v'Data.Functor.Identity' -- -- Some link to a type: t'Data.Functor.Identity' The default is still the type (with a warning about the ambiguity)
| | * | | | Bump to GHC 8.10Ben Gamari2019-11-101-1/+1
| | | | | |
| | * | | | Define `XRec` for location information and get rid of `HasSrcSpan`Sebastian Graf2019-11-011-16/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In https://gitlab.haskell.org/ghc/ghc/merge_requests/1970 I propose a simpler way to encode location information into the GHC and Haddock AST while incurring no cost for e.g. TH which doesn't need location information. These are just changes that have to happen in lock step.
| * | | | | Match GHC, adding IsUnicodeSyntax field to HsFunTy and HsScaledAlan Zimmerman2020-10-216-17/+20
| | | | | | | | | | | | | | | | | | | | | | | | (cherry picked from commit a7d1d8e034d25612d5d08ed8fdbf6f472aded4a1)
| * | | | | Updates for the new linear types syntax: a %p -> bVladislav Zavialov2020-09-301-0/+1
| | | | | |
| * | | | | Bump GHC version to 9.0Ben Gamari2020-07-282-2/+2
| | | | | |
* | | | | | Merge pull request #1281 from obsidiansystems/wip/backpack-jBen Gamari2020-12-311-2/+4
|\ \ \ \ \ \ | | | | | | | | | | | | | | Changes to support -j with backpack
| * | | | | | Support a new ghc --make node type for parallel backpack upsweepJohn Ericson2020-12-281-2/+4
| | | | | | |
* | | | | | | Inline and fix getGADTConTypeGVladislav Zavialov2020-12-292-36/+16
|/ / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The getGADTConTypeG used HsRecTy, which is at odds with GHC issue #18782. I noticed that getGADTConTypeG was only used in the Hoogle backend. Interestingly, when handling H98 constructors, Hoogle converts RecCon to PrefixCon (see Haddock.Backends.Hoogle.ppCtor). So I changed getGADTConTypeG to handle RecConGADT in the same manner as PrefixConGADT, and after this simplification moved it into the 'where' clause of ppCtor, to the only place where it is used. The practical effect of this change is as follows. Consider this example: data TestH98 = T98 { bar::Int } data TestGADT where TG :: { foo :: Int } -> TestGADT Before this patch, haddock --hoogle used to produce: T98 :: Int -> TestH98 [TG] :: {foo :: Int} -> TestGADT Notice how the record syntax was discarded in T98 but not TG. With this patch, we always produce signatures without record syntax: T98 :: Int -> TestH98 [TG] :: Int -> TestGADT I suspect this might also be a bugfix, as currently Hoogle doesn't seem to render GADT record constructors properly.
* | | | | / Adapt to changes to GlobalRdrElt and AvailInfoAdam Gundry2020-12-233-14/+6
| |_|_|_|/ |/| | | | | | | | | | | | | | Needed for ghc/ghc!4467
* | | | | Enable two warnings (#1245) (#1268)tomjaguarpaw2020-12-198-1/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | because they will be soon be added to -Wall. See https://gitlab.haskell.org/ghc/ghc/-/issues/15656
* | | | | Adapt to HsCoreTy (formerly NewHsTypeX) becoming a type synonymRyan Scott2020-12-165-5/+5
| | | | | | | | | | | | | | | | | | | | Needed for !4417, the fix for GHC#15706 and GHC#18914.
* | | | | Display linear/multiplicity arrows correctly (#1238)Krzysztof Gogolewski2020-12-163-7/+25
| | | | | | | | | | | | | | | | | | | | Previously we were ignoring multiplicity and displayed a %1 -> b as a -> b.
* | | | | Merge remote-tracking branch 'upstream/ghc-head' into ghc-headBen Gamari2020-12-157-9/+1
|\ \ \ \ \
| * | | | | Revert "Enable two warnings (#1245) (#1268)"Ben Gamari2020-12-157-9/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | As this does not build on GHC `master`. This reverts commit 7936692badfe38f23ae95b51fb7bd7c2ff7e9bce.
* | | | | | Revert "Update for boxed rep"Ben Gamari2020-12-152-6/+5
|/ / / / / | | | | | | | | | | | | | | | This reverts commit 4ffb30d8b637ccebecc81ce610f0af451ac8088d.
* | | | | Update for boxed repAndrew Martin2020-12-142-5/+6
| | | | |
* | | | | Enable two warnings (#1245) (#1268)tomjaguarpaw2020-12-107-1/+9
| | | | | | | | | | | | | | | | | | | | | | | | | because they will be soon be added to -Wall. See https://gitlab.haskell.org/ghc/ghc/-/issues/15656
* | | | | Merge pull request #1257 from AndreasPK/wip/andreask/opt_dumpsBen Gamari2020-12-031-1/+1
|\ \ \ \ \ | | | | | | | | | | | | Update for changes in GHC's Pretty