aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock/Backends/Xhtml.hs
Commit message (Collapse)AuthorAgeFilesLines
* coot/multiple package (ghc-head) (#1419)Marcin Szamotulski2021-08-161-36/+101
| | | | | | | | | | | | | | | | | | | | | | | * FromJSON class Aeson style FromJSON class with Parsec based json parser. * doc-index.json file for multiple packages When creating haddock summary page for multiple packages render doc-index.json file using contents of all found 'doc-index.json' files. * Render doc-index.json When rendering html, render doc-index.json file independently of maybe_index_url option. doc-index.json file is useful now even if maybe_index_url is not `Nothing`. * base url option New `Flag_BaseURL` which configures from where static files are loaded (--base-url). If given and not equal "." static files are not coppied, as this indicates that they are not read from the the directory where we'd copy them. The default value is ".".
* Match changes in GHC AST for in-tree API AnnotationsAlan Zimmerman2021-03-151-2/+1
| | | | As landed via https://gitlab.haskell.org/ghc/ghc/-/merge_requests/2418
* Merge remote-tracking branch 'origin/ghc-head' into wip/ghc-head-mergeBen Gamari2021-02-061-4/+1
|\
| * Make haddock more robust to changes to the `Language` data typeJoachim Breitner2021-01-221-4/+1
| | | | | | | | | | | | | | | | | | With the introduction of GHC2021, the `Languages` data type in GHC will grow. In preparation of that (and to avoid changing haddock with each new language), this change makes the code handle extensions to that data type gracefully. (cherry picked from commit c341dd7c9c3fc5ebc83a2d577c5a726f3eb152a5)
* | Merge remote-tracking branch 'origin/ghc-8.10' into ghc-9.0Ben Gamari2021-01-051-2/+13
|\ \ | |/ |/|
| * Changes for GHC#17566Alex Biehl2020-12-081-1/+1
| | | | | | | | See https://gitlab.haskell.org/ghc/ghc/merge_requests/2469
| * 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
| * 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`
* | Fix after unit refactoringSylvain Henry2020-06-081-7/+8
| |
* | Modules: TypesSylvain Henry2020-03-181-1/+1
| |
* | Modules: Driver (#13009)Sylvain Henry2020-02-191-1/+1
| |
* | Changes for GHC#17566Ryan Scott2020-01-251-1/+1
|/ | | | See https://gitlab.haskell.org/ghc/ghc/merge_requests/2469
* Refactor names + unused functions (#982)Alec Theriault2018-12-171-5/+2
| | | | | | | This commit should not introduce any change in functionality! * consistently use `getOccString` to convert `Name`s to strings * compare names directly when possible (instead of comparing strings) * get rid of unused utility functions
* [TTG: Handling Source Locations] Foundation and PatShayan-Najd2018-11-231-2/+2
| | | | | | | | | | | Trac Issues #15495 This patch removes the ping-pong style from HsPat (only, for now), using the plan laid out at https://ghc.haskell.org/trac/ghc/wiki/ImplementingTreesThatGrow/HandlingSourceLocations (solution A). - the class `HasSrcSpan`, and its functions (e.g., `cL` and `dL`), are introduced - some instances of `HasSrcSpan` are introduced - some constructors `L` are replaced with `cL` - some patterns `L` are replaced with `dL->L` view pattern - some type annotation are necessarily updated (e.g., `Pat p` --> `Pat (GhcPass p)`)
* Merge branch 'ghc-8.6' into ghc-headAlec Theriault2018-11-101-14/+25
|\
| * Merge branch 'ghc-8.6' into wip/new-oceanAlec Theriault2018-11-091-10/+17
| |\
| | * Only run MathJax on entities with "mathjax" class (#960)Alec Theriault2018-11-051-9/+15
| | | | | | | | | | | | | | | | | | | | | Correspondingly, we wrap all inline/diplay math in <span class="mathjax"> ... the math .... </span> This fixes #959.
| * | Clicking on "Contents" navigates to top of pageAlec Theriault2018-11-081-1/+1
| | |
| * | Allow "Contents" summary to scroll in a fixed divAlec Theriault2018-11-071-2/+2
| | | | | | | | | | | | | | | 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-071-0/+1
| | | | | | | | | | | | | | | | | | * swap the minimize unicode to something more intuitive * use new unicode expander/collapser for instance lists * address some alignment issues in the "index" page
| * | 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-181-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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
| |/
* / Set UTF-8 encoding before writing files (#934)Alec Theriault2018-10-161-5/+5
|/ | | | | This should fix #929, as well as guard against future problems of this sort in other places. Basically replaces 'writeFile' (which selects the users default locale) with 'writeUtf8File' (which always uses utf8).
* Merge branch 'ghc-head' with 'ghc-8.4'Herbert Valerio Riedel2018-05-011-1/+1
|\
| * Match changes in GHC for TTGAlan Zimmerman2018-04-271-1/+1
| |
| * Use withBinaryFilealexbiehl2018-02-181-1/+1
| |
| * QuickJump: Mitigate encoding problems on Windowsalexbiehl2018-02-181-4/+5
| | | | | | | | (cherry picked from commit 86292c54bfee2343aee84559ec01f1fc68f52231)
* | @since includes package name (#749)Alec Theriault2018-03-271-53/+57
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
* | Use withBinaryFilealexbiehl2018-02-041-1/+1
| |
* | QuickJump: Mitigate encoding problems on Windowsalexbiehl2018-02-031-4/+5
| |
* | Clickable anchors for headings (#716)Alec Theriault2018-02-011-1/+2
|/ | | | See #579. This just adds an <a> tag around the heading, pointing to the heading itself.
* Merge remote-tracking branch 'origin/master' into ghc-headalexbiehl2017-10-311-27/+33
|\
| * Remote tabalexbiehl2017-10-311-2/+1
| |
| * Copy quickjump.css for nicer error messagesalexbiehl2017-10-311-3/+3
| |
| * Supported reexported-modules via --reexport flag.Edward Z. Yang2017-10-311-14/+11
| | | | | | | | Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>
| * Put Quickjump behind --quickjump flag (#697)Alexander Biehl2017-10-301-8/+11
| |
| * Use <details> element for collapsibles (#690)Tim Baumann2017-10-091-7/+14
| | | | | | | | | | | | | | | | | | | | | | * Remove unnecessary call to 'collapseSection' The call is unnecessary since there is no corresponding toggle for hiding the section of orphan instances. * Use <details> for collapsibles This makes them work even when JS is disabled. Closes #560.
* | Fix merge falloutalexbiehl2017-10-081-5/+4
| |
* | Merge remote-tracking branch 'origin/ghc-head' into HEADalexbiehl2017-10-081-5/+7
|\ \ | |/ |/|
| * Merge remote-tracking branch 'origin/master' into ghc-headalexbiehl2017-08-211-64/+11
| |\
| * | Match new AST as per GHC wip/new-tree-one-paramAlan Zimmerman2017-06-051-7/+7
| | | | | | | | | | | | See https://ghc.haskell.org/trac/ghc/wiki/ImplementingTreesThatGrow
| * | Render (signature) only if it actually is a signature!Edward Z. Yang2017-04-221-2/+5
| | | | | | | | | | | | | | | | | | I forgot a conditional, oops! Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>
| * | Merge commit '240bc38b94ed2d0af27333b23392d03eeb615e82' into HEADBen Gamari2017-03-231-43/+16
| |\ \
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-11 14:10:17 +0000