aboutsummaryrefslogtreecommitdiff
path: root/haddock-library/src/Documentation/Haddock/Parser.hs
Commit message (Collapse)AuthorAgeFilesLines
* Add support for labeled module referencesIñaki García Etxebarria2021-02-071-13/+41
| | | | | | | | | | 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".
* Add dangling changes from branches ghc-8.6 and ghc-8.8 (#1243)Xia Li-yao2020-12-081-1/+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>
* Allow more characters in anchor following module reference (#1220)Xia Li-yao2020-12-081-2/+8
|
* `haddock-library` document header levelAlec Theriault2020-03-281-4/+4
| | | | | Document the fact the header level is going to always be between 1 and 6 inclusive. Along the way, I also optimized the parsing code a bit.
* Update parsing to strip whitespace from table cells (#1074)Alina Banerjee2020-03-201-7/+7
| | | | | | | | | | * Update parsing to strip leading & trailing whitespace from table cells * Update fixture data to disallow whitespaces at both ends in table cells * Add test case for whitespaces stripped from both ends of table cells * Update table reference test data for html tests
* Fix build-failure regression for base < 4.7Herbert Valerio Riedel2019-12-081-1/+0
| | | | | | | | | | | | | The `$>` operator definition is available only since base-4.7 which unfortunately wasn't caught before release to Hackage (but has been fixed up by a metadata-revision) This commit introduces a `CompatPrelude` module which allows to reduce the amount of CPP by ousting it to a central location, i.e. the new `CompatPrelude` module. This pattern also tends to reduce the tricks needed to silence unused import warnings. Addresses #1119
* Better identifier parsingAlec Theriault2019-02-251-59/+4
| | | | | | | | | | | | | | | | * '(<|>)' 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).
* Support value/type namespaces on identifier linksAlec Theriault2019-02-251-8/+14
| | | | | | | | | | | Identifier links can be prefixed with a 'v' or 't' to indicate the value or type namespace of the desired identifier. For example: -- | Some link to a value: v'Data.Functor.Identity' -- -- Some link to a type: t'Data.Functor.Identity' The default is still the type (with a warning about the ambiguity)
* Fix warnings, accept outputAlec Theriault2018-12-121-1/+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
* Accept test caseAlec Theriault2018-11-061-1/+1
|
* Support (and flatten) inline markup in image linksAlec Theriault2018-11-061-5/+10
| | | | | | | Inline markup is supported in image links but, as per the [commonmark recommendation][0], it is stripped back to a plain text representation. [0]: https://spec.commonmark.org/0.28/#example-547
* Support hyperlink labels with inline markupAlec Theriault2018-11-061-10/+12
| | | | The parser for pictures hasn't been properly adjusted yet.
* Faster 'Text' driven parser combinatorsAlec Theriault2018-11-051-14/+16
| | | | | | | | Perf only change: * use 'getParserState'/'setParserState' to make 'Text'-optimized parser combinators * minimize uses of 'Data.Text.{pack,unpack,cons,snoc}'
* Replace 'attoparsec' with 'parsec' (#799)Alec Theriault2018-04-251-192/+236
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Remove attoparsec with parsec and start fixing failed parses * Make tests pass * Fix encoding issues The Haddock parser no longer needs to worry about bytestrings. All the internal parsing work in haddock-library happens over 'Text'. * Remove attoparsec vendor * Fix stuff broken in 'attoparsec' -> 'parsec' * hyperlinks * codeblocks * examples Pretty much all issues are due to attoparsec's backtracking failure behaviour vs. parsec's non-backtracking failure behaviour. * Fix small TODOs * Missing quote + Haddocks * Better handle spaces before/after paragraphs * Address review comments
* @since includes package name (#749)Alec Theriault2018-03-271-3/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
* Make a proper definition for the <link> parserSimon Jakobi2018-03-141-4/+6
|
* Restore backward-compat with base-4.5 through base-4.8Herbert Valerio Riedel2018-03-101-2/+27
|
* Support unicode operators, proper modulesAlec Theriault2018-03-021-22/+12
| | | | | | | | Unicode operators are a pretty big thing in Haskell, so supporting linking them seems like it outweighs the cost of the extra machinery to force Attoparsec to look for unicode. Fixes #458.
* Grid Tables (#718)Oleg Grenrus2018-02-011-3/+193
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add table examples * Add table types and adopt simple parser Simple parser is done by Giovanni Cappellotto (@potomak) in https://github.com/haskell/haddock/pull/577 It seems to support single fine full tables, so far from full RST-grid tables, but it's good start. Table type support row- and colspans, but obviously parser is lacking. Still TODO: - Latex backend. Should we use multirow package https://ctan.org/pkg/multirow?lang=en? - Hoogle backend: ? * Implement grid-tables * Refactor table parser * Add two ill-examples * Update CHANGES.md * Basic documentation for tables * Fix documentation example
* Take until line feedalexbiehl2018-02-011-1/+1
|
* Remove scanner, takeWhile1_ already takes care of escapingalexbiehl2018-02-011-14/+1
|
* Treat escaped \] better in definition lists (#717)Alexander Biehl2018-02-011-1/+14
| | | This fixes #546.
* Fixup haddockAlexander Biehl2017-07-311-1/+1
|
* Consequently use inClass and notInClass in haddock-library (#617)Alex Biehl2017-05-131-8/+13
| | | These allow attoparsec to do some clever lookup optimization
* Fix the documentation for haddock itself.Dominic Steinitz2015-12-211-9/+15
| | | | | | | | | | | | | | | Change notation and add support for inline math. Allow newlines in display math. Add a command line option for the mathjax url (you might want to use a locally installed version). Rebase tests because of extra url and version change. Respond to (some of the) comments. Fix warnings in InterfaceFile.hs
* Handle inline math with mathjax.Dominic Steinitz2015-12-211-1/+15
|
* Make nested lists count indentation according to first item.Łukasz Hanuszczak2015-05-271-35/+46
|
* Create simple method for indentation parsing.Łukasz Hanuszczak2015-05-271-0/+9
|
* Filter '\r' from comments due to Windows problems.Vincent Berthoux2015-01-221-2/+3
| | | | | On Windows this was causing newline to be rendered twice in code blocks. Closes #359, fixes #356.
* Disambiguate string-literalsHerbert Valerio Riedel2014-12-121-4/+4
| | | | | | | | GHC fails type-inference with `OverloadedStrings` + `Data.Foldable.elem` otherwise. Conflicts: haddock-library/src/Documentation/Haddock/Parser.hs
* Update doctest parts of commentsMateusz Kowalczyk2014-12-101-18/+22
|
* Allow the parser to spit out meta-infoMateusz Kowalczyk2014-12-101-2/+4
| | | | | | | | | | | | | | | 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.
* (wip) Add support for @since (closes #26)Simon Hengel2014-11-161-6/+20
|
* State intention rather than implementation details in Haddock commentSimon Hengel2014-11-161-1/+1
|
* newtype-wrap parser monadSimon Hengel2014-11-081-1/+1
|
* Minor code simplificationSimon Hengel2014-11-081-4/+3
|
* Fix parsing of identifiers written in infix wayMateusz Kowalczyk2014-11-041-11/+12
|
* Allow an optional colon after the closing bracket of definition listsSimon Hengel2014-11-031-1/+1
| | | | | This is to disambiguate them from markdown links and will be require with a future release.
* Add support for markdown imagesSimon Hengel2014-11-031-2/+10
|
* Allow markdown links at the beginning of a paragraphSimon Hengel2014-11-031-2/+18
|
* Add support for markdown links (closes #336)Simon Hengel2014-11-031-2/+20
|
* parser: Try to parse definition lists right before text paragraphsSimon Hengel2014-11-031-1/+1
|
* Minor refactoringSimon Hengel2014-11-031-22/+28
|
* Remove unused language extensionsSimon Hengel2014-11-031-4/+0
|
* Fix #313 by doing some list munging.Mateusz Kowalczyk2014-08-151-13/+13
| | | | | | I get rid of the Monoid instance because we weren't satisfying the laws. Convenience of having <> didn't outweigh the shock-factor of having it behave badly.
* Catch mid-line URLs. Fixes #314.Mateusz Kowalczyk2014-07-281-2/+2
|
* Don't mangle append order for nested lists.Mateusz Kowalczyk2014-06-251-14/+2
| | | | | | | | The benefit of this is that the ‘top-level’ element of such lists is properly wrapped in <p> tags so any CSS working with these will be applied properly. It also just makes more sense. Pointed out at jgm/pandoc#1346.
* Drop DocParagraph from front of headersMateusz Kowalczyk2014-06-251-1/+6
| | | | | I can not remember why they were wrapped in paragraphs to begin with and it seems unnecessary now that I test it. Closes #307.
* Fix anchors. Closes #308.Mateusz Kowalczyk2014-06-251-3/+8
|
* Fixed haddock warnings.John MacFarlane2014-06-181-6/+4
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-27 19:37:35 +0000