aboutsummaryrefslogtreecommitdiff
path: root/haddock-api/src/Haddock/Backends/Xhtml/Layout.hs
Commit message (Collapse)AuthorAgeFilesLines
* @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