aboutsummaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch 'ghc-head' with 'ghc-8.4'Herbert Valerio Riedel2018-05-011-0/+14
|\
| * Constructor and pattern synonym argument docs (#709)Alec Theriault2018-01-131-0/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Support Haddocks on constructor arguments This is in conjunction with https://phabricator.haskell.org/D4094. Adds support for rendering Haddock's on (non-record) constructor arguments, both for regular and GADT constructors. * Support haddocks on pattern synonym arguments It appears that GHC already parsed these - we just weren't using them. In the process of doing this, I tried to deduplicate some code around handling patterns. * Update the markup guide Add some information about the new support for commenting constructor arguments, and mention pattern synonyms and GADT-style constructors. * Overhaul LaTeX support for data/pattern decls This includes at least * fixing several bugs that resulted in invalid LaTeX * fixing GADT data declaration headers * overhaul handling of record fields * overhaul handling of GADT constructors * overhaul handling of bundled patterns * add support for constructor argument docs * Support GADT record constructors This means changes what existing HTML docs look like. As for LaTeX, looks like GADT records were never even supported. Now they are. * Clean up code/comments Made code/comments consistent between the LaTeX and XHTML backend when possible. * Update changelog * Patch post-rebase regressions * Another post-rebase change We want return values to be documentable on record GADT constructors.
* | Add grid table example to cheatsheetAlexander Biehl2018-02-011-0/+17
| | | | | | (pdf and svg need to be regenerated thought)
* | Grid Tables (#718)Oleg Grenrus2018-02-011-0/+20
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* Fix tiny typo in docs (#693)Veronika Romashkina2017-10-241-1/+1
|
* Provide --show-interface option to dump interfaces (#645)Alexander Biehl2017-08-061-0/+5
| | | | | | | | | | | | | | | | | | | | | | * 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.
* Import @aisamanra's Haddock cheatsheetHerbert Valerio Riedel2017-07-205-0/+1181
| | | | from https://github.com/aisamanra/haddock-cheatsheet
* Improve documenation of Haddock markup (#614)Nathan Collins2017-05-111-93/+357
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Improve documentation of Haddock markup. - document that Haddock supports inferring types top-level functions with without type signatures, but also explain why using this feature is discouraged. Looks like this feature has been around since version 2.0.0.0 in 2008! - rework the "Module description" section: - move the general discussion of field formatting to the section intro and add examples illustrating the prose for multiline fields. - mention that newlines are preserved in some multiline fields, but not in others (I also noticed that commas in the `Copyright` field are not preserved; I'll look into this bug later). - add a subsection for the module description fields documentation, and put the field keywords in code formatting (double back ticks) instead of double quotes, to be consistent with the typesetting of keywords in other parts of the documentation. - mention that "Named chunks" are not supported in the long-form "Module description" documentation. - fix formatting of keywords in the "Module attributes" section. Perhaps these errors were left over from an automatic translation to ReST from some other format as part of the transition to using Sphinx for Haddock documentation? Also, add a missing reference here; it just said "See ?"! - update footnote about special treatment for re-exporting partially imported modules not being implemented. In my tests it's not implemented at all -- I tried re-exporting both `import B hiding (f)` and `import B (a, b)` style partial imports, and in both cases got the same result as with full imports `import B`: I only get a module reference. * Rework the `Controlling the documentation structure` section. My main goal was to better explain how to use Haddock without an export list, since that's my most common use case, but I hope I improved the section overall: - remove the incomplete `Omitting the export list` section and fold it into the other sections. In particular, summarize the differences between using and not using an export list -- i.e. control over what and in what order is documented -- in the section lead. - add "realistic" examples that use the structure markup, both with and without an export list. I wanted a realistic example here to capture how it can be useful to explain the relationship between a group of functions in a section, in addition to documenting their individual APIs. - make it clear that you can associate documentation chunks with documentation sections when you aren't using an export list, and that doing it in the most obvious way -- i.e. with `-- |`, as you can in the export list -- doesn't work without an export list. It took me a while to figure this out the first time, since the docs didn't explain it at all before. - add a "no export list" example to the section header section. - add more cross references. * Add examples of gotchas for markup in `@...@`. I'm not sure this will help anyone, since I think most people first learn about `@...@` by reading other people's Haddocks, but I've documented the mistakes which I've made and then gotten confused by. * Use consistent Capitalization of Titles. Some titles were in usual title caps, and others only had the first word capitalized. I chose making them all use title caps because that seems to make the cross references look better.
* Add $ as a special characterOmari Norman2016-06-291-1/+1
| | | | | | | | If this character is not escaped, documentation built with Haddock 2.17.2 will fail. This was not an issue with 2.16 series, which causes builds to fail and there is nothing in the docs or error message giving a clue about why builds that used to succeed now don't.
* Fix math typo and add link.Dominic Steinitz2016-06-091-2/+2
|
* Camel case MathJax.Dominic Steinitz2016-06-091-1/+1
|
* Fix spelling mistake.Dominic Steinitz2016-06-091-1/+1
|
* Documentation for LaTeX markup.Dominic Steinitz2016-06-091-0/+15
|
* remove framed view of the HTML documentation (see #114 and #274)Sebastian Meric de Bellefon2016-05-241-6/+2
| | | | | Frames are a bit broken, ignored by Hackage, and considered obsolete in general. This patch disables frames generation. The mini_*.html files are still used in the synopsis.
* doc: Use whichever theme sphinx deems appropriateBen Gamari2016-05-161-1/+0
|
* Revert "doc: Vendorize alabaster Sphinx theme"Ben Gamari2016-05-162-1/+0
| | | | | | | This ended up causes far too many issues to be worthwhile. We'll just have to live with inconsistent haddock documentation. This reverts commit cec21957001143794e71bcd9420283df18e7de40.
* doc: Vendorize alabaster Sphinx themeBen Gamari2016-05-162-0/+1
| | | | | | Alabaster is now the default sphinx theme and is a significant improvement over the previous default that it's worthproviding it when unavailable (e.g. Sphinx <1.3).
* doc: Use `$(MAKE)` instead of `make`Ben Gamari2016-05-141-1/+1
| | | | This is necessary to ensure we use gmake.
* doc: Fix GHC clean ruleBen Gamari2016-05-121-1/+1
| | | | Apparently GHC's build system doesn't permit wildcards in clean paths.
* doc: Add html as an all-target for ghcBen Gamari2016-05-111-2/+2
| | | | Otherwise the html documentation won't be installed for binary-dist.
* doc: Add clean targetsBen Gamari2016-05-111-0/+2
|
* doc: At long last fix ghc.mkBen Gamari2016-05-011-2/+2
| | | | | | | The variable reference was incorrectly escaped, meaning that Sphinx documentation was never installed. (cherry picked from commit 609018dd09c4ffe27f9248b2d8b50f6196cd42b9)
* doc: Fix option referencesBen Gamari2016-04-101-7/+8
| | | | (cherry picked from commit f915fb3c74328fb994235bbbd42092a691539197)
* doc: Only install if BUILD_SPHINX_HTML==YESBen Gamari2016-04-101-0/+2
| | | | | | Fixes GHC #11818. (cherry picked from commit c6d6a18d85e5e2d9bb5904e6919e8a8d7e31c4c5)
* Document --use-unicode flagBen Gamari2016-02-081-0/+4
|
* doc: Switch to SphinxBen Gamari2016-02-0815-2721/+1613
|
* Make some version changes after 2.16.1 releaseMateusz Kowalczyk2015-07-221-1/+1
|
* Fix incorrect specification of source style option in doc file.Łukasz Hanuszczak2015-07-041-2/+2
|
* Update docs on using `--read-interface` option.Łukasz Hanuszczak2015-07-041-7/+29
|
* Update docs with information about source hyperlinking.Łukasz Hanuszczak2015-07-041-0/+37
|
* Update some meta data at the top of the docsMateusz Kowalczyk2015-06-031-2/+11
|
* Update docs with info on new list nesting ruleMateusz Kowalczyk2015-06-031-0/+11
| | | | Fixes #278 through commits from PR #401
* Turn the README into GitHub Markdown format.Njagi Mwaniki2014-12-291-7/+6
| | | | Closes #354
* Update docs for @sinceMateusz Kowalczyk2014-12-181-0/+34
|
* Fix parsing of identifiers written in infix wayMateusz Kowalczyk2014-11-041-1/+3
|
* Allow an optional colon after the closing bracket of definition listsSimon Hengel2014-11-031-9/+4
| | | | | This is to disambiguate them from markdown links and will be require with a future release.
* Add support for markdown imagesSimon Hengel2014-11-031-8/+11
|
* Update documentationSimon Hengel2014-11-031-12/+32
|
* Experimental support for collapsable headersMateusz Kowalczyk2014-10-291-2/+21
| | | | Closes #335
* Mention --print-missing-docsMateusz Kowalczyk2014-09-041-0/+12
|
* Make the doc parser not complainMateusz Kowalczyk2014-08-311-1/+9
|
* Bump version in docMateusz Kowalczyk2014-08-311-1/+1
|
* Bump down the version for master to 2.14.4Mateusz Kowalczyk2014-08-141-1/+1
|
* Fix anchors. Closes #308.Mateusz Kowalczyk2014-06-251-2/+5
|
* Clear up highlighting of identifiers with ‘'’s.Mateusz Kowalczyk2014-06-051-0/+5
|
* Fix up some whitespaceMateusz Kowalczyk2014-03-111-783/+783
|
* Bump version to 2.15.0Mateusz Kowalczyk2014-03-111-1/+1
|
* Add documentation for --source-entity-lineNiklas Haas2014-03-111-0/+7
|
* Change rendering of duplicate record field docsMateusz Kowalczyk2014-02-271-0/+23
| | | | | | | | See Haddock Trac #195. We now change this behaviour to only rendering the documentation attached to the first instance of a duplicate field. Perhaps we could improve this by rendering the first instance that has documentation attached to it but for now, we'll stick with this.
* Fix wording in the docsMateusz Kowalczyk2014-02-241-3/+3
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-11 11:38:22 +0000