aboutsummaryrefslogtreecommitdiff
path: root/haddock-library/src/Documentation/Haddock
Commit message (Collapse)AuthorAgeFilesLines
* Merge remote-tracking branch 'origin/ghc-9.4'Ben Gamari2022-08-051-0/+1
|\
| * Link to (~)Vladislav Zavialov2022-03-141-0/+1
| |
* | fix parsing trailing quotes in backticked identifiers (#1408) (#1483)Artem Pelenitsyn2022-05-081-2/+2
| |
* | Keep track of ordered list indexes and render them (#1407)Ben Simms2022-05-033-8/+23
| | | | | | | | | | * Keep track of ordered list indexes and render them * Rename some identifiers to clarify
* | Follow hlint, remove language pragmas in libs. (#1478)Phil de Joux2022-05-033-4/+1
| |
* | Parse Markdown links at beginning of line within a paragraph (#1470)Steve Hart2022-04-121-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Catch Markdown links at beginning of line within paragraph Per Issue #774, Markdown links were being parsed as ordinary text when they occurred at the beginning of a line other than the first line of the paragraph. This occurred because the parser was not interpreting a left square bracket as a special character that could delimit special markup. A space character was considered a special character, so, if a space occurred at the beginning of the new line, then the parser would interpret the space by itself and then continue parsing, thereby catching the Markdown link. '\n' was not treated as a special character, so the parser did not catch a Markdown link that may have followed. Note that this will allow for Markdown links that are not surrounded by spaces. For example, the following text includes a Markdown link that will be parsed: Hello, world[label](url) This is consistent with how the parser handles other types of markup. * Remove obsolete documentation hint Commit 6b9aeafddf20efc65d3725c16e3fc43a20aac343 should eliminate the need for the workaround suggested in the documentation.
* | spelling errors (#1471)askeblad2022-04-061-1/+1
| |
* | typos (#1464)askeblad2022-03-162-3/+3
|/
* Remove dubious parseModLinkalexbiehl2021-02-071-4/+0
| | | | Instead construct the ModLink value directly when parsing.
* Add support for labeled module referencesIñaki García Etxebarria2021-02-073-19/+53
| | | | | | | | | | 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-082-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-282-5/+5
| | | | | 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.
* Fix crash in `haddock-library` on unicode spaceAlec Theriault2020-03-271-7/+7
| | | | | | | | | | | | | Our quickcheck tests for `haddock-library` stumbled across an edge case input that was causing Haddock to crash: it was a unicode space character. The root cause of the crash is that we were implicitly assuming that if a space character was not " \t\f\v\r", it would have to be "\n". We fix this by instead defining horizontal space as: any space character that is not '\n'. Fixes #1142
* 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-083-29/+3
| | | | | | | | | | | | | 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
* Document error-prone conditional definition of instancesHerbert Valerio Riedel2019-12-081-0/+6
| | | | | | | | | This can easily trip up people if one isn't aware of it. Usually it's better to avoid this kind of conditionality especially for typeclasses for which there's an compat-package as conditional instances like these tend to fragment the ecosystem into those packages that go the extra mile to provide backward compat via those compat-packages and those that fail to do so.
* Release haddock-2.23, haddock-library-1.8.0Alec Theriault2019-05-261-5/+5
| | | | | Tentatively adjust bounds and changelogs for the release to be bundled with GHC 8.8.1.
* Better identifier parsingAlec Theriault2019-02-253-60/+202
| | | | | | | | | | | | | | | | * '(<|>)' 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-252-8/+24
| | | | | | | | | | | 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)
* Remove `Documentation.Haddock.Utf8`Alec Theriault2019-02-031-74/+0
| | | | | | | | | | | | The circumstances under which this module appeared are completely gone. The Hyperlinker backend no longer needs this module (it uses the more efficient `Encoding` module from `ghc`). Why no deprecation? Because this module really shouldn't exist! - It isn't used in `haddock-library`/`haddock-api` anymore - It was copy pasted directly from `utf8-string` - Folks seeking a boot-lib only solution can use `ghc`'s `Encoding`
* Fix warnings, accept outputAlec Theriault2018-12-122-2/+2
| | | | | | | * 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-062-5/+44
| | | | | | | 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-063-41/+43
| | | | The parser for pictures hasn't been properly adjusted yet.
* Faster 'Text' driven parser combinatorsAlec Theriault2018-11-053-35/+83
| | | | | | | | Perf only change: * use 'getParserState'/'setParserState' to make 'Text'-optimized parser combinators * minimize uses of 'Data.Text.{pack,unpack,cons,snoc}'
* Build on 7.4 and 7.8Alec Theriault2018-10-161-1/+2
|
* Add docs for some DocH constructors (#814)Simon Jakobi2018-06-131-0/+3
|
* Replace 'attoparsec' with 'parsec' (#799)Alec Theriault2018-04-253-387/+348
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-273-8/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-102-2/+28
|
* Remove bang patternAlec Theriault2018-03-021-3/+3
|
* Support unicode operators, proper modulesAlec Theriault2018-03-022-24/+35
| | | | | | | | 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-013-4/+216
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
* Refactoring: Make doc renaming monadicalexbiehl2017-08-161-0/+3
| | | | This allows us to later throw warnings if can't find an identifier
* Bifoldable and Bitraversable for DocH and MetaDocalexbiehl2017-08-161-0/+61
|
* Provide --show-interface option to dump interfaces (#645)Alexander Biehl2017-08-061-1/+32
| | | | | | | | | | | | | | | | | | | | | | * WIP: Provide --show-interface option to dump interfaces Like ghcs own --show-iface this flag dumps a binary interface file to stdout in a human (and machine) readable fashion. Currently it uses json as output format. * Fill all the jsonNull stubs * Rework Bifunctor instance of DocH, update changelog and documentation * replace changelog, bring DocMarkupH doc back * Update CHANGES.md * Update CHANGES.md * Move Control.Arrow up It would result in unused import if the Bifunctor instance is not generated.
* Prepare haddock-library-1.4.5 releasealexbiehl2017-07-312-1/+13
|
* Fixup haddockAlexander Biehl2017-07-311-1/+1
|
* Move `DocMarkup` from haddock-api to haddock-library (#659)Alexander Biehl2017-07-312-0/+86
| | | | | | | | | | * Move `DocMarkup` from haddock-api to haddock-library * Move more markup related functions * Markup module * CHANGELOG
* Make haddock-library and haddock-api warning free (#626)Alex Biehl2017-05-301-1/+3
|
* Consequently use inClass and notInClass in haddock-library (#617)Alex Biehl2017-05-132-11/+19
| | | These allow attoparsec to do some clever lookup optimization
* Make parser state a newtypeDavid Feuer2016-05-241-1/+1
| | | | | | Previously, it was `data` wrapping a `Maybe`, which seems a bit silly. Obviously, this can be changed back if anyone wants to add more fields some day.
* Fix the documentation for haddock itself.Dominic Steinitz2015-12-212-9/+16
| | | | | | | | | | | | | | | 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-212-1/+16
|
* Make nested lists count indentation according to first item.Łukasz Hanuszczak2015-05-271-35/+46
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-21 13:50:52 +0000