aboutsummaryrefslogtreecommitdiff
path: root/haddock-api
Commit message (Collapse)AuthorAgeFilesLines
* Use `.hie` files for the Hyperlinker backend (#977)Alec Theriault2019-01-3114-665/+771
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | # Summary This is a large architectural change to the Hyperlinker. * extract link (and now also type) information from `.hie` instead of doing ad-hoc SYB traversals of the `RenamedSource`. Also adds a superb type-on-hover feature (#715). * re-engineer the lexer to avoid needless string conversions. By going directly through GHC's `P` monad and taking bytestring slices, we avoid a ton of allocation and have better handling of position pragmas and CPP. In terms of performance, the Haddock side of things has gotten _much_ more efficient. Unfortunately, much of this is cancelled out by the increased GHC workload for generating `.hie` files. For the full set of boot libs (including `ghc`-the-library) * the sum of total time went down by 9-10% overall * the sum of total allocations went down by 6-7% # Motivation Haddock is moving towards working entirely over `.hi` and `.hie` files. This change means we no longer need the `RenamedSource` from `TypecheckedModule` (something which is _not_ in `.hi` files). # Details Along the way a bunch of things were fixed: * Cross package (and other) links are now more reliable (#496) * The lexer tries to recover from errors on every line (instead of at CPP boundaries) * `LINE`/`COLUMN` pragmas are taken into account * filter out zero length tokens before rendering * avoid recomputing the `ModuleName`-based `SrcMap` * remove the last use of `Documentation.Haddock.Utf8` (see #998) * restructure temporary folder logic for `.hi`/`.hie` model
* Visible kind application haddock updatemynguyen2018-12-3010-24/+76
|
* Properly synify and render promoted type variables (#985)Alec Theriault2018-12-232-4/+6
| | | | | | | | * Synify and render properly promoted type variables Fixes #923. * Accept output
* Refactor names + unused functions (#982)Alec Theriault2018-12-177-62/+26
| | | | | | | 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
* Output better debug infromation on internal error in extractDeclZejun Wu2018-12-141-1/+3
| | | | This will make investigation of #979 easier
* Fix warnings, accept outputAlec Theriault2018-12-126-8/+1
| | | | | | | * remove redundant imports (only brought to light due to recent work for improving redundant import detection) * fix a bug that was casuing exports to appear in reverse order * fix something in haddock-library that prevented compilation on old GHC's
* [TTG: Handling Source Locations] Foundation and PatShayan-Najd2018-11-237-36/+75
| | | | | | | | | | | 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)`)
* Follow GHC HEAD's HsTypes.Promoted -> BasicTypes.PromotionFlag changeAlp Mestanogullari2018-11-157-10/+15
| | | | It got introduced in ghc/ghc@ae2c9b40f5b6bf272251d1f4107c60003f541b62.
* Merge branch 'ghc-8.6' into ghc-headAlec Theriault2018-11-1026-1952/+4535
|\
| * Replace oplus/ominus expander/collapser icons with trianglesAlec Theriault2018-11-101-3/+3
| |
| * Merge branch 'ghc-8.6' into wip/new-oceanAlec Theriault2018-11-096-30/+45
| |\
| | * 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-263-13/+21
| | | | | | | | | | | | | | | | | | | | | | | | 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.
| * | Space out functions moreAlec Theriault2018-11-081-6/+2
| | | | | | | | | | | | | | | Also, functions and data decls now have the same space before and after them.
| * | Clicking on "Contents" navigates to top of pageAlec Theriault2018-11-081-1/+1
| | |
| * | overflow-y 'scroll' -> 'auto'Alec Theriault2018-11-071-2/+2
| | |
| * | Allow "Contents" summary to scroll in a fixed divAlec Theriault2018-11-073-14/+13
| | | | | | | | | | | | | | | 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-076-14/+11
| | | | | | | | | | | | | | | | | | * swap the minimize unicode to something more intuitive * use new unicode expander/collapser for instance lists * address some alignment issues in the "index" page
| * | Revert "Make 'Contents' in NewOcean scrollable"Alec Theriault2018-10-261-2/+0
| | | | | | | | | | | | | | | | | | | | | This reverts commit f909ffd8353d6463fd5dd184998a32aa98d5c922. I missed the fact this also forces the 'Contents' to always go down to the bottom of the page.
| * | Make 'Contents' in NewOcean scrollableAlec Theriault2018-10-261-0/+2
| | | | | | | | | | | | | | | | | | This only happens if the contents block on the left is so big that it doesn't fit (vertically) on the page. If that happens, we want it to be scrollable.
| * | 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
| | |
| * | Indent more things + slightly smaller fontAlec Theriault2018-10-251-2/+2
| | |
| * | Don't hide bullets in method docsAlec Theriault2018-10-252-4/+4
| | | | | | | | | | | | | | | | | | | | | I think thst CSS was meant only to deal with fields and the effect on bullets was accidental. Fixes #926.
| * | Fix the synopsis buttonAlec Theriault2018-10-241-5/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Here's these changes are supposed to do: * put the synopsis back on the right side * properly have it on the edge of the screen on wide screens * adjust the background of the synopsis to match the button (otherwise the grey blends in with what is underneath) * get rid of the dotted purple line * the synopsis contents are now scrollable even when in wide screens (this has been a long-standing bug)
| * | Fix copy-pasta error in data-filesAlec Theriault2018-10-242-5/+5
| | |
| * | Resurrect the style-switcherAlec Theriault2018-10-245-30/+42
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This fixes #810. Looks like things were broken during the quickjump refactor of the JS. For the (git) record: I do not think the style switcher is a good idea. I'm fixing it for the same reason @mzero added it; as an answer to "rumblings from some that they didn't want their pixels changed on bit"
| * | Update JS dependenciesAlec Theriault2018-10-244-1860/+3510
| | | | | | | | | | | | | | | This was done via `npm audit fix`. I think this fixes #903 along with some more serious vulnerabilities that nobody seems to have noticed.
| * | Update 'data-files' to include NewOcean stuffAlec Theriault2018-10-211-0/+5
| | |
| * | 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.
| * | Improve code blocks stylingNuno Alexandre2018-10-181-7/+25
| | | | | | | | | | | | | | | - Fix and improve spacing - Improve colors and borders
| * | Update font in Xhtml.hs to PT SansNuno Alexandre2018-10-181-1/+1
| | |
| * | Misc of tweaksNuno Alexandre2018-10-181-10/+32
| | | | | | | | | | | | | | | | | | | | | - Update link colors to hackage scheme - Tune spacing between content elements - Update footer style - Fix and improve code blocks identation
| * | Use 'flex' to fix header alignmentNuno Alexandre2018-10-181-11/+55
| | |
| * | Update font to PT SansNuno Alexandre2018-10-181-13/+21
| | | | | | | | | | | | Also migrate some general text related changes from hackage.
| * | Avoid name shadowingalexbiehl2018-10-181-2/+3
| | |
| * | Fix issue with menu alignment on firefoxNunoAlexandre2018-10-181-0/+1
| | | | | | | | | | | | | | | Reported and described here: https://github.com/haskell/haddock/pull/721#issuecomment-374668869
| * | Fix responsive triggers overlap issueNunoAlexandre2018-10-181-4/+4
| | | | | | | | | | | | | | | | | | | | | The min and max width triggers have the same values, which caused the style resolution to take an intersection of both style declarations when the screen resolution had the size of the limts (say 1280px), causing an odd behaviour and look.
| * | Minor adjustmentsNunoAlexandre2018-10-181-3/+11
| | | | | | | | | | | | | | | | | | Bring in some adjustments made to hackage: - link colors - page header show everything when package title is too long
| * | Improve information densityNuno Alexandre2018-10-181-48/+74
| | | | | | | | | | | | | | | | | | | | | - Reduce font size - Improve space between and within code blocks - Improve alignments - Improve spacing within sub-blocks
| * | Make synopsis scrollable on wide screensNuno Alexandre2018-10-181-0/+1
| | | | | | | | | | | | | | | When the synopsis is longer than the screen, you can’t see its end and you can't scroll down either, making the content unreachable.
| * | Address several PR commentsNuno Alexandre2018-10-181-43/+78
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Darken text color like done for hackage - Move synopsis to left side - Make table of contents stick to the left on wide screens - Wrap links to avoid page overflow - Improve expand/collapse buttons - Fix issue with content size on mobile devices - Fix issue with font-size on landscape mode - Increase width of the content - Change colors of table of contents and synopsis - Etc
| * | 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.
| * | Decrease space between code blocksNuno Alexandre2018-10-181-7/+7
| | | | | | | | | | | | | | | There was too much space between code blocks as pointed out by reviewers.
| * | Improve synopsis style and codeNuno Alexandre2018-10-181-13/+13
| | | | | | | | | | | | | | | - Use CSS3 instead of loading pictures to show "+" and "-" symbols - Drop redundant code
| * | 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-183-48/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | | Several things are addressed here: - better responsive behaviour on the header - better space usage - consistent colors overall - other nit PR comments
| * | Make it responsiveNunoAlexandre2018-10-181-10/+61
| | | | | | | | | | | | | | | | | | - It makes small screens taking more space than larger ones - fixes a few issues present in small screens currently - make it look good across different screen sizes.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-23 19:36:33 +0000