aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock/Backends
Commit message (Collapse)AuthorAgeFilesLines
...
| * | | Display linear/multiplicity arrows correctly (#1238)Krzysztof Gogolewski2021-02-053-7/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously we were ignoring multiplicity and displayed a %1 -> b as a -> b. (cherry picked from commit b4b4d896d2d68d6c48e7db7bfe95c185ca0709cb)
* | | | Add support for labeled module referencesIñaki García Etxebarria2021-02-074-12/+21
|/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | Support a markdown-style way of annotating module references. For instance -- | [label]("Module.Name#anchor") will create a link that points to the same place as the module reference "Module.Name#anchor" but the text displayed on the link will be "label".
* | | Cleanup: fix build warningsVladislav Zavialov2021-02-051-1/+1
| | |
* | | Add import list to Data.ListOleg Grenrus2021-01-241-1/+1
| |/ |/|
* | Merge remote-tracking branch 'origin/ghc-8.10' into ghc-9.0Ben Gamari2021-01-0511-258/+334
|\ \
| * | Adapt Haddock for QualifiedDoMatthías Páll Gissurarson2020-12-081-2/+2
| | |
| * | Changes for GHC#17566Alex Biehl2020-12-083-3/+5
| | | | | | | | | | | | See https://gitlab.haskell.org/ghc/ghc/merge_requests/2469
| * | Enable two warnings (#1245)tomjaguarpaw2020-12-082-0/+2
| | | | | | | | | | | | | | | because they will be soon be added to -Wall. See https://gitlab.haskell.org/ghc/ghc/-/issues/15656
| * | Add dangling changes from branches ghc-8.6 and ghc-8.8 (#1243)Xia Li-yao2020-12-081-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Fix multiple typos and inconsistencies in doc/markup.rst Note: I noticed some overlap with #1112 from @wygulmage and #1081 from @parsonsmatt after creating these proposed changes - mea culpa for not looking at the open PRs sooner. * Fix #1113 If no Signatures, no section of index.html * Change the formatting of missing link destinations The current formatting of the missing link destination does not really help user to understand the reasons of the missing link. To address this, I've changed the formatting in two ways: - the missing link symbol name is now fully qualified. This way you immediately know which haskell module cannot be linked. It is then easier to understand why this module does not have documentation (hidden module or broken documentation). - one line per missing link, that's more readable now that symbol name can be longer due to qualification. For example, before haddock was listing missing symbol such as: ``` could not find link destinations for: Word8 Word16 mapMaybe ``` Now it is listed as: ``` could not find link destinations for: - Data.Word.Word8 - Data.Word.Word16 - Data.Maybe.mapMaybe ``` * Add `--ignore-link-symbol` command line argument This argument can be used multiples time. A missing link to a symbol listed by `--ignore-link-symbol` won't trigger "missing link" warning. * Forbid spaces in anchors (#1148) * Improve error messages with context information (#1060) Co-authored-by: Matt Audesse <matt@mattaudesse.com> Co-authored-by: Mike Pilgrem <mpilgrem@users.noreply.github.com> Co-authored-by: Guillaume Bouchard <guillaume.bouchard@tweag.io> Co-authored-by: Pepe Iborra <pepeiborra@gmail.com>
| * | Add support for custom section anchors (#1179)Iñaki2020-04-251-1/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This allows to have stable anchors for groups, even if the set of groups in the documentation is altered. The syntax for setting the anchor of a group is -- * Group name #desiredAnchor# Which will produce an html anchor of the form '#g:desiredAnchor' Co-authored-by: Iñaki García Etxebarria <git@inaki.blueleaf.cc>
| * | Disallow links in section headersAlec Theriault2020-03-281-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is quite straightforward to implement, since we already had a function `docToHtmlNoAnchors` (which we used to generate the link in the sidebar "Contents"). This breaks test `Bug387`, but that test case has aged badly: we now automatically generate anchors for all headings, so manually adding an anchor in a section makes no sense. Nested anchors are, as pointed out in #1054, disallowed by the HTML standard. Fixes #1054
| * | Use `unLoc`/`noLoc` from GHC instead of `unL`/`reL`Alec Theriault2020-03-283-15/+15
| | | | | | | | | | | | | | | | | | | | | | | | * `unL` is already defined by GHC as `unLoc` * `reL` is already defined by GHC as `noLoc` (in a safer way too!) * Condense `setOutputDir` and add a about exporting from GHC Fixes #978
| * | Use TTG empty extensions to remove some `error`'sAlec Theriault2020-03-282-3/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | None of these error cases should ever have been reachable, so this is just a matter of leveraging the type system to assert this. * Use the `NoExtCon` and `noExtCon` to handle case matches for no extension constructors, instead of throwing an `error`. * Use the extension field of `HsSpliceTy` to ensure that this variant of `HsType` cannot exist in an `HsType DocNameI`.
| * | Remove unused `Haddock.Utils` functionsAlec Theriault2020-03-281-0/+4
| | | | | | | | | | | | | | | | | | | | | * removed functions in `Haddock.Utils` that were not used anywhere (or exported from the `haddock-api` package) * moved GHC-specific utils from `Haddock.Utils` to `Haddock.GhcUtils`
| * | Tentative 2.24 releaseAlec Theriault2020-03-221-1/+1
| | | | | | | | | | | | | | | Adjusted changelogs and versions in `.cabal` files in preparation for the upcoming release bundled with GHC 8.10.
| * | Clean up warningsAlec Theriault2020-03-224-12/+3
| | | | | | | | | | | | | | | | | | * unused imports * imports of `Data.List` without import lists * missing `CompatPrelude` file in `.cabal`
| * | Merge branch 'ghc-8.8' into ghc-8.10Alec Theriault2020-03-2010-263/+346
| |\ \
| | * | Replace the 'caption' class so that the collapsible sections are shownKleidukos2020-03-191-1/+1
| | | |
| | * | Prefer un-hyperlinked sources to no sourcesAlec Theriault2019-10-072-14/+26
| | | | | | | | | | | | | | | | | | | | | | | | It is possible to fail to extract an HIE ast. This is however not a reason to produce _no_ output - we should still make a colorized HTML page.
| | * | Fix crash when there are no srcspans in the file due to CPPZubin Duggal2019-10-071-8/+11
| | | |
| | * | update for new way to store hiefile headersZubin Duggal2019-06-041-2/+3
| | | |
| | * | Matching changes in GHC for #16236Alan Zimmerman2019-03-292-5/+5
| | | | | | | | | | | | | | | | (cherry picked from commit 3ee6526d4ae7bf4deb7cd1caf24b3d7355573576)
| | * | Remove workaround for now-fixed Clang CPP bug (#1028)Alec Theriault2019-03-292-48/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-093-51/+99
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-034-73/+64
| | |\ \
| | | * | 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
| | | * | 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
| | | | |
| | * | | Better identifier parsingAlec Theriault2019-02-254-25/+40
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * '(<|>)' 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).
* | | | | Match GHC, adding IsUnicodeSyntax field to HsFunTy and HsScaledAlan Zimmerman2020-10-211-1/+2
| | | | | | | | | | | | | | | | | | | | (cherry picked from commit a7d1d8e034d25612d5d08ed8fdbf6f472aded4a1)
* | | | | Updates for the new linear types syntax: a %p -> bVladislav Zavialov2020-09-301-0/+1
| |_|_|/ |/| | |
* | | | Sync with GHC removing {-# CORE #-} pragmaKrzysztof Gogolewski2020-07-121-2/+0
| | | | | | | | | | | | | | | | See ghc ticket #18048
* | | | Handle LexicalNegation's ITprefixminusVladislav Zavialov2020-06-281-0/+1
| | | |
* | | | Adapt Haddock for QualifiedDoMatthías Páll Gissurarson2020-06-261-2/+2
| | | |
* | | | Adapt Haddock to LinearTypesKrzysztof Gogolewski2020-06-175-26/+32
| | | | | | | | | | | | | | | | See ghc/ghc!852.
* | | | Use HsForAllTelescope (GHC#18235)Ryan Scott2020-06-133-41/+45
| | | |
* | | | Merge pull request #1202 from hsyl20/wip/hsyl20/unitid-iiBen Gamari2020-06-092-8/+9
|\ \ \ \ | | | | | | | | | | Fix after unit refactoring
| * | | | Fix after unit refactoringSylvain Henry2020-06-082-8/+9
| | | | |
* | | | | Changes for GHC#18191Ryan Scott2020-06-052-2/+2
|/ / / / | | | | | | | | | | | | See https://gitlab.haskell.org/ghc/ghc/-/merge_requests/3337.
* | | | update for hiefile-typeclass-infoZubin Duggal2020-05-241-14/+20
| | | |
* | | | Explicit Specificity Support for HaddockGert-Jan Bottu2020-05-203-19/+52
| | | |
* | | | Atomic update of NameCache in readHieFileZubin Duggal2020-05-041-3/+5
| | | |
* | | | Fix for GHC.Unit.* modulesSylvain Henry2020-04-273-3/+3
| | | |
* | | | UnitId has been renamed into UnitSylvain Henry2020-04-272-2/+2
| | | |
* | | | Module structureSylvain Henry2020-04-249-17/+16
| | | |
* | | | Module renamingSylvain Henry2020-04-102-4/+4
| | | |
* | | | Make NoExtCon fields strictRyan Scott2020-04-073-22/+0
| | | | | | | | | | | | | | | | | | | | These changes are a part of a fix for [GHC#17992](https://gitlab.haskell.org/ghc/ghc/issues/17992).
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-11 19:10:55 +0000