aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock
Commit message (Collapse)AuthorAgeFilesLines
* 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
* 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-201-1/+8
| | | | | | | | | | * 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
* Rename 'NewOcean' theme to 'Linuwial'Alec Theriault2018-11-111-1/+1
|
* Merge branch 'ghc-8.6' into wip/new-oceanAlec Theriault2018-11-095-20/+28
|\
| * Only run MathJax on entities with "mathjax" class (#960)Alec Theriault2018-11-052-11/+17
| | | | | | | | | | | | | | Correspondingly, we wrap all inline/diplay math in <span class="mathjax"> ... the math .... </span> This fixes #959.
| * Fix documentation in `haddock-api` (#957)Alec Theriault2018-10-271-5/+5
| | | | | | | | | | | | | | | | | | | | | | * Fix misplaced Haddocks in Haddock itself Haddock should be able to generate documentation for 'haddock-api' again. * Make CI check that documentation can be built. * Add back a doc that is OK
| * Avoid some partialityAlec Theriault2018-10-262-3/+4
| | | | | | | | | | | | | | | | AFAICT this wasn't causing any crashes, but that's mostly because we happen not to be forcing `pkgStr` when it would diverge. We come dangerously close to doing that in `ppHtmlIndex`. Fixes #569.
* | Clicking on "Contents" navigates to top of pageAlec Theriault2018-11-081-1/+1
| |
* | Allow "Contents" summary to scroll in a fixed divAlec Theriault2018-11-072-4/+5
| | | | | | | | | | In the unfortunate event that the "Contents" summary doesn't fit vertically (like in the "Prelude"), it will be scrollable.
* | Fix issues around plus/minusAlec Theriault2018-11-072-3/+5
| | | | | | | | | | | | * swap the minimize unicode to something more intuitive * use new unicode expander/collapser for instance lists * address some alignment issues in the "index" page
* | Merge branch 'ghc-8.6' into wip/new-oceanAlec Theriault2018-10-252-8/+11
|\|
| * Avoid more conflicts in generated ids (#954)Alec Theriault2018-10-251-6/+10
| | | | | | | | | | This fixes #953 by passing more names into the generated ids.
| * Fix typo in a warningSimon Jakobi2018-10-231-2/+1
| |
* | Make package-header caption backward-compatibleNuno Alexandre2018-10-181-2/+2
| | | | | | | | | | | | | | The current html generator of this branch wraps the package-header caption as a div, which does not work (without style adjustments) with the old themes. Changing it from div to span does the trick, without needing to adjust the old stylesheets.
* | Update font in Xhtml.hs to PT SansNuno Alexandre2018-10-181-1/+1
| |
* | Avoid name shadowingalexbiehl2018-10-181-2/+3
| |
* | Add an initial-scale property to all haddock pagesNuno Alexandre2018-10-181-2/+3
| | | | | | | | | | This solves an issue reported about the content looking incredibly small on mobile devices.
* | Place the package name before the menu linksNuno Alexandre2018-10-181-2/+2
| | | | | | | | | | This supports the expected responsive menu design, where the package name appears above the menu links.
* | Make the style consistent with hackageNuno Alexandre2018-10-182-4/+4
| | | | | | | | | | | | | | | | | | Several things are addressed here: - better responsive behaviour on the header - better space usage - consistent colors overall - other nit PR comments
* | Update html test reference filesNunoAlexandre2018-10-181-1/+1
| |
* | Include custom font in the html headNunoAlexandre2018-10-181-1/+2
|/
* Output pattern synonyms in Hoogle backend (#947)Alec Theriault2018-10-161-8/+13
| | | | | | | | | | | * Output pattern synonyms in Hoogle backend We were previously weren't outputting _any_ pattern synonyms, bundled or not. Now, we output both. Fixes #946. * Update changelog
* Latex type families (#734)Alec Theriault2018-10-162-144/+209
| | | | | | | | | | | | | | | | | | | | * Support for type families in LaTeX The code is ported over from the XHTML backend. * Refactor XHTML and LaTeX family handling This is mostly a consolidation effort: stripping extra exports, inlining some short definitions, and trying to make the backends match. The LaTeX backend now has preliminary support for data families, although the only the data instance head is printed (not the actual constructors). Both backends also now use "newtype" for newtype data family instances. * Add some tests
* Merge branch 'ghc-8.4' into ghc-8.6Alec Theriault2018-10-161-0/+1
|\
| * Avoid "invalid argument (invalid character)" on non-unicode Windows (#892)Yuji Yamamoto2018-07-231-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Steps to reproduce and the error message ==== ``` > stack haddock basement ... snip ... Warning: 'A' is out of scope. Warning: 'haddock: internal error: <stdout>: commitBuffer: invalid argument (invalid character) ``` Environment ==== OS: Windows 10 ver. 1709 haddock: [HEAD of ghc-8.4 when I reproduce the error](https://github.com/haskell/haddock/commit/532b209d127e4cecdbf7e9e3dcf4f653a5605b5a). (I had to use this version to avoid another probrem already fixed in HEAD) GHC: 8.4.3 stack: Version 1.7.1, Git revision 681c800873816c022739ca7ed14755e85a579565 (5807 commits) x86_64 hpack-0.28.2 Related pull request ==== https://github.com/haskell/haddock/pull/566
| * Fix broken instance source links (#869)Alec Theriault2018-07-202-19/+22
| | | | | | | | | | | | | | | | | | The problem manifests itself in instances that are defined in modules other than the module where the class is defined. The fix is just to thread through the 'Module' of the instance further along. Since orphan instances appear to already have been working, I didn't do anything there.
| * Preserve docs on type family instances (#867)Alec Theriault2018-07-202-2/+8
| | | | | | | | | | | | | | | | | | * Preserve docs on type family instances The only problem was that the instance location was slightly off for type family instances. * Accept output
| * tyThingToLHsDecl: Preserve type synonyms that contain a forall (#880)Simon Jakobi2018-07-191-2/+46
| | | | | | | | | | | | | | | | | | | | * tyThingToLHsDecls: Preserve type synonyms that contain a forall Fixes #879. * Add Note [Invariant: Never expand type synonyms] * Clarify Note [Invariant: Never expand type synonyms]
| * Avoid line breaks due to line length in Hoogle (#868)Alec Theriault2018-07-061-3/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | * Avoid line breaks due to line length in Hoogle Hoogle operates in a line-oriented fashion, so we should avoid ever breaking due to long lines. One way of doing this non-intrusively is to modify the 'DynFlags' that are threaded through the 'Hoogle' module (note this is anyways only passed through for use in the various 'showSDoc' functions). * Amend test case
| * Export more fixities for Hoogle (#871)Alec Theriault2018-07-051-2/+2
| | | | | | | | This exports fixities for more things, including class methods and type-level operators.
| * Renamer: Warn about ambiguous identifiers (#831)Simon Jakobi2018-06-082-5/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Renamer: Warn about ambiguous identifiers Example: Warning: 'elem' is ambiguous. It is defined * in ‘Data.Foldable’ * at /home/simon/tmp/hdk/src/Lib.hs:7:1 You may be able to disambiguate the identifier by qualifying it or by hiding some imports. Defaulting to 'elem' defined at /home/simon/tmp/hdk/src/Lib.hs:7:1 Fixes #830. * Deduplicate warnings Fixes #832.
| * Improve hyperlinker's 'spanToNewline' (#846)Alec Theriault2018-06-051-7/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 'spanToNewline' is used to help break apart the source into lines which can then be partioned into CPP and non-CPP chunks. It is important that 'spanToNewline' not break apart tokens, so it needs to properly handle things like * block comments, possibly nested * string literals, possibly multi-line * CPP macros, possibly multi-line String literals in particular were not being properly handled. The fix is to to fall back in 'Text.Read.lex' to help lex things that are not comments. Fixes #837.
| * Use `ClassOpSig` instead of `TypeSig` for class methods (#835)Alec Theriault2018-05-231-4/+4
| | | | | | | | | | | | | | | | * Fix minimal pragma handling Class declarations contain 'ClassOpSig' not 'Typesig'. This should fix #834. * Accept html-test output
| * WibblesRyan Scott2018-05-101-3/+3
| |
| * Remove Hoogle backend hack that butchers infix datatype namesRyan Scott2018-05-101-2/+1
| |
| * Renamer: Warn about out of scope identifiers. (#819)Simon Jakobi2018-05-081-6/+11
| |
| * Remove 'TokenGroup' from Hyperlinker (#818)Alec Theriault2018-05-081-50/+14
| | | | | | | | | | Since the hyperlinker backend now relies on the GHC tokenizer, something like 'Bar.Baz.foo' already gets bunched together into one token (as opposed to being spread across 'Bar', '.', 'Baz', '.', and 'foo').
| * Filter out CRLFs in hyperlinker backend (#813)Alec Theriault2018-05-071-2/+7
| | | | | | This prevents spurious lines from appearing in the final output.
* | Accumulate explicitly which modules to load for 'attachInstances'Alec Theriault2018-08-212-28/+42
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The old approach to fixing #469, while correct, consumes a lot of memory. We ended up with a HUGE 'GblRdrEnv' in 'ic_rn_gbl_env'. However, 'getNameToInstancesIndex' takes that environment and compresses it down to a much smaller 'ModuleSet'. Now, we compute that 'ModuleSet' explicitly as we process modules. That way we can just tell 'getNameToInstancesIndex' what modules to load (instead of it trying to compute that information from the interactive context). (cherry picked from commit 5c7c596c51d69b92164e9ba920157b36ce2b2ec1)
* | Match XFieldOcc rename in GHCAlan Zimmerman2018-07-301-1/+1
| | | | | | | | | | | | Trac #15386 (cherry picked from commit e3926b50ab8a7269fd6904b06e881745f08bc5d6)
* | outOfScope: Recommend qualifying the identifierSimon Jakobi2018-07-201-1/+3
| |
* | Don't warn about ambiguous identifiers when the candidate names belong to ↵Simon Jakobi2018-07-201-18/+35
| | | | | | | | | | | | | | | | | | | | the same type This also changes the defaulting heuristic for ambiguous identifiers. We now prefer local names primarily, and type constructors or class names secondarily. Partially fixes #854.
* | Update the ghc-8.6 branch (#889)Simon Jakobi2018-07-208-180/+274
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Revert "Bump GHC version to 8.6" This was applied to the wrong branch; there's now a `ghc-8.6` branch; ghc-head is always supposed to point to GHC HEAD, i.e. an odd major version. The next version bump to `ghc-head` is supposed to go from e.g. 8.5 to 8.7 This reverts commit 5e3cf5d8868323079ff5494a8225b0467404a5d1. * README updates (#856) * README: Remove mentions of master branch * README: Add instructions for using html-test * README: Change command to run _all_ the testsuites * README: Add project overview section (cherry picked from commit 61d6f935da97eb96685f07bf385102c2dbc2a33c) * Export more fixities for Hoogle (#871) This exports fixities for more things, including class methods and type-level operators. (cherry picked from commit 88316b972e3d47197b1019111bae0f7f87275fce) * Avoid line breaks due to line length in Hoogle (#868) * Avoid line breaks due to line length in Hoogle Hoogle operates in a line-oriented fashion, so we should avoid ever breaking due to long lines. One way of doing this non-intrusively is to modify the 'DynFlags' that are threaded through the 'Hoogle' module (note this is anyways only passed through for use in the various 'showSDoc' functions). * Amend test case (cherry picked from commit 657b1b3d519545f8d4ca048c06210d6cbf0f0da0) * tyThingToLHsDecl: Preserve type synonyms that contain a forall (#880) * tyThingToLHsDecls: Preserve type synonyms that contain a forall Fixes #879. * Add Note [Invariant: Never expand type synonyms] * Clarify Note [Invariant: Never expand type synonyms] (cherry picked from commit c3eb3f0581f69e816f9453b1747a9f2a3ba02bb9) * Fix HEAD html-test (#860) * Update tests for 'StarIsType' * Accept tests * Revert "Update tests for 'StarIsType'" This reverts commit 7f0c01383bbba6dc5af554ee82988d2cf44e407a. * Refactor handling of parens in types (#874) * Fix type parenthesization in Hoogle backend Ported the logic in the HTML and LaTeX backends for adding in parens into something top-level in 'GhcUtil'. Calling that from the Hoogle backend fixes #873. * Remove parenthesizing logic from LaTeX and XHTML backends Now, the only times that parenthesis in types are added in any backend is through the explicit 'HsParTy' constructor. Precedence is also represented as its own datatype. * List out cases explicitly vs. catch-all * Fix printing of parens for QuantifiedConstraints The priority of printing 'forall' types was just one too high. Fixes #877. * Accept HTML output for quantified contexts test * Preserve docs on type family instances (#867) * Preserve docs on type family instances The only problem was that the instance location was slightly off for type family instances. * Accept output (cherry picked from commit 133e9c2c168db19c1135479f7ab144c4e33af2a4) * Fix broken instance source links (#869) The problem manifests itself in instances that are defined in modules other than the module where the class is defined. The fix is just to thread through the 'Module' of the instance further along. Since orphan instances appear to already have been working, I didn't do anything there. (cherry picked from commit 2de7c2acf9b1ec85b09027a8bb58bf8512e91c05) * Add some more unicode related tests (#872) This has been fixed for sure ever since we switched from attoparsec to parsec. Parts of it may have been working before that, but there was a point where this would have failed (see #191). A regression test never hurt anyone. :) (cherry picked from commit 5ec7715d418bfac0f26aec6039792a99a6e89370) * Misc tests (#858) * More tests * spliced types * constructor/pattern argument docs * strictness marks on fields with argument docs * latex test cases need seperate directory * Accept tests * Additional tests for the identifier parser (#816) * Add tests for the identifier parser * docs: Clarify how to delimit identifiers (cherry picked from commit 0861affeca4d72938f05a2eceddfae2c19199071)
* | Remove HsEqTy and XEqTyRyan Scott2018-06-196-14/+6
| |
* | Match changes in GHC for #14259Alan Zimmerman2018-06-192-4/+4
| |
* | Revert unintentional reversion of fix of #548Ben Gamari2018-06-141-2/+23
| |