aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock/Backends/Xhtml/Layout.hs
Commit message (Collapse)AuthorAgeFilesLines
* Match changes in GHC AST for in-tree API AnnotationsAlan Zimmerman2021-03-151-1/+1
| | | | As landed via https://gitlab.haskell.org/ghc/ghc/-/merge_requests/2418
* Merge remote-tracking branch 'origin/ghc-8.10' into ghc-9.0Ben Gamari2021-01-051-0/+4
|\
| * Better support for default methods in classesAlec Theriault2019-03-091-0/+4
| | | | | | | | | | | | | | | | | | | | * 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
* | UnitId has been renamed into UnitSylvain Henry2020-04-271-1/+1
| |
* | Module structureSylvain Henry2020-04-241-1/+1
| |
* | Modules: TypesSylvain Henry2020-03-181-1/+1
| |
* | Ignore the BufLoc/BufSpan added in GHC's !2516Vladislav Zavialov2020-02-281-2/+2
|/
* Allow "Contents" summary to scroll in a fixed divAlec Theriault2018-11-071-2/+3
| | | | | 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-3/+4
| | | | | | * swap the minimize unicode to something more intuitive * use new unicode expander/collapser for instance lists * address some alignment issues in the "index" page
* 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.
* 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 the ghc-8.6 branch (#889)Simon Jakobi2018-07-201-15/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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)
* @since includes package name (#749)Alec Theriault2018-03-271-28/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
* Show where instances are defined (#748)Alec Theriault2018-03-211-5/+7
| | | | | | | | | | | | | | * Indicate source module of instances Above instance, we now also display a link to the module where the instance was defined. This is sometimes helpful in figuring out what to import. * Source module for type/data families too * Remove parens * Accept tests
* Use <details> element for collapsibles (#690)Tim Baumann2017-10-091-6/+8
| | | | | | | | | | | * 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.
* Haddock support for bundled pattern synonyms (#627)Christiaan Baaij2017-06-091-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Haddock support for bundled pattern synonyms * Add fixities to bundled pattern synonyms * Add bundled pattern synonyms to the synopsis * Store bundled pattern fixities in expItemFixities * Add test for bundled pattern synonyms * Stop threading fixities * Include bundled pattern synonyms for re-exported data types Sadly, fixity information isn't found for re-exported data types * Support for pattern synonyms * Modify tests after #631 * Test some reexport variations * Also lookup bundled pattern synonyms from `InstalledInterface`s * Check isExported for bundled pattern synonyms * Pattern synonym is exported check * Always look for pattern synonyms in the current module Another overlooked cornercase * Account for types named twice in export lists Also introduce a fast function for nubbing on a `Name` and use it throughout the code base. * correct fixities for reexported pattern synonyms * Fuse concatMap and map * Remove obsolete import * Add pattern synonyms to visible exports * Fix test * Remove corner case
* Ensure expanded family instances render correctlyRyanGlScott2016-04-161-1/+1
| | | | (cherry picked from commit 1338b5d7c32939de6bbc31af0049477e4f847103)
* Collapse type/data family instances by defaultRyanGlScott2016-04-161-5/+13
| | | | (cherry picked from commit 2da130a8db8f995c119b544fad807533236cf088)
* Move the permalinks to "#" on the right sidePhil Ruffwind2016-02-081-4/+7
| | | | | | | | | Since pull request #407, the identifiers have been permalinked to themselves, but this makes it difficult to copy the identifier by double-clicking. To work around this usability problem, the permalinks are now placed on the far right adjacent to "Source", indicated by "#". Also, 'namedAnchor' now uses 'id' instead of 'name' (which is obsolete).
* Merge remote-tracking branch 'phadej/orphans' into ghc-headBen Gamari2015-12-201-2/+12
|\
| * Print orphan instances header only if requiredOleg Grenrus2015-09-281-1/+2
| |
| * Generate docs for orphan instancesOleg Grenrus2015-09-271-2/+11
| |
* | s/PackageKey/UnitId/g and s/packageKey/unitId/gEdward Z. Yang2015-12-141-1/+1
|/ | | | Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>
* Fix issue with instance expander hijacking type hyperlink click.Łukasz Hanuszczak2015-08-211-2/+2
|
* Make instance details section contain associated types information.Łukasz Hanuszczak2015-08-211-5/+6
|
* Attach section title to the instance methods block.Łukasz Hanuszczak2015-08-211-1/+1
|
* Get rid of no longer used layout method.Łukasz Hanuszczak2015-08-211-10/+2
|
* Rearrange layout of instance methods in generated documentation.Łukasz Hanuszczak2015-08-211-1/+1
|
* Split instance subsection layout method to top-level declarations.Łukasz Hanuszczak2015-08-211-5/+22
|
* Improve placement of instance methods expander button.Łukasz Hanuszczak2015-08-211-3/+3
|
* Make specialized signatures refer to original signature declaration.Łukasz Hanuszczak2015-08-211-1/+1
|
* Add expandable method section for each class instance declaration.Łukasz Hanuszczak2015-08-211-1/+15
|
* Fix record field alignment when name is too longPhil Ruffwind2015-08-021-6/+4
| | | | | | | | | | | Change <dl> to <ul> and use display:table rather than floats to layout the record fields. This avoids bug #301 that occurs whenever the field name gets too long. Slight aesthetic change: the entire cell of the field's source code is now shaded gray rather than just the area where text exists. Fixes #301. Closes #421
* Fix typo in Haddock.Backends.Xhtml.Layout: divSynposis -> divSynopsisPhil Ruffwind2015-08-021-3/+3
| | | | Closes #408
* Fix alignment of Source links in instance table in FirefoxPhil Ruffwind2015-06-121-2/+3
| | | | | | | | | | | | | | | | | | | Due to a Firefox bug [1], a combination of 'whitespace: nowrap' on the parent element with 'float: right' on the inner element can cause the floated element to be displaced downwards for no apparent reason. To work around this, the left side is wrapped in its own <span> and set to 'float: left'. As a precautionary measure to prevent the parent element from collapsing entirely, we also add the classic "clearfix" hack. The latter is not strictly needed but it helps prevent bugs if the layout is altered again in the future. Fixes #384. Remark: line 159 of src/Haddock/Backends/Xhtml/Layout.hs was indented to prevent confusion over the operator precedence of (<+>) vs (<<). [1]: https://bugzilla.mozilla.org/show_bug.cgi?id=488725
* Attach to instance location the name that has the same location filejpmoresmau2015-06-121-12/+12
| | | | Fixes #383
* Links to source location of class instance definitionsjpmoresmau2015-01-221-12/+32
|
* Revert "Merge branch 'reverts'"Mateusz Kowalczyk2014-12-121-1/+1
| | | | | | | | This reverts commit 5c93cc347773c7634321edd5f808d5b55b46301f, reversing changes made to 5b81a9e53894d2ae591ca0c6c96199632d39eb06. Conflicts: haddock-api/src/Haddock/Convert.hs
* Allow the parser to spit out meta-infoMateusz Kowalczyk2014-12-101-1/+1
| | | | | | | | | | | | | | | Currently we only use it only for ‘since’ annotations but with these patches it should be fairly simple to add new attributes if we wish to. Closes #26. It seems to work fine but due to 7.10 rush I don't have the chance to do more exhaustive testing right now. The way the meta is output (emphasis at the end of the whole comment) is fairly arbitrary and subject to bikeshedding. Note that this makes test for Bug310 fail due to interface version bump: it can't find the docs for base with this interface version so it fails. There is not much we can do to help this because it tests for ’built-in’ identifier, not something we can provide ourselves.
* Experimental support for collapsable headersMateusz Kowalczyk2014-10-291-4/+5
| | | | Closes #335
* Move sources under haddock-api/srcMateusz Kowalczyk2014-08-231-0/+235