aboutsummaryrefslogtreecommitdiff
path: root/haddock-api
Commit message (Collapse)AuthorAgeFilesLines
* removed custom ids for packages and modulesYuchen Pei2022-09-141-10/+6
| | | | they are not really used in links
* fixing namespace typ and val, and relevant link genYuchen Pei2022-09-141-8/+13
|
* Moving file writing to inside org backendYuchen Pei2022-08-162-8/+23
| | | | Also handling odir now
* removed some unused pragmasYuchen Pei2022-08-161-4/+0
|
* handling associated types for classesYuchen Pei2022-08-161-25/+47
| | | | Also fixed the familydecl a bit
* include hadrian build instructions in readmeYuchen Pei2022-07-211-142/+0
| | | | Also moved readme out to root dir for better forge rendering.
* Merge remote-tracking branch 'upstream/main'Yuchen Pei2022-07-212-57/+8
|\
| * Follow hlint suggestion: unused LANGUAGE pragma. (#1504)Phil de Joux2022-07-191-1/+0
| | | | | | | | | | * Follow hlint suggestion: unused LANGUAGE pragma. * Ignore within modules to pass linting and pass tests.
| * Bump shell-quote from 1.6.1 to 1.7.3 in /haddock-api/resources/html (#1500)dependabot[bot]2022-06-211-56/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Bumps [shell-quote](https://github.com/substack/node-shell-quote) from 1.6.1 to 1.7.3. - [Release notes](https://github.com/substack/node-shell-quote/releases) - [Changelog](https://github.com/substack/node-shell-quote/blob/master/CHANGELOG.md) - [Commits](https://github.com/substack/node-shell-quote/compare/1.6.1...1.7.3) --- updated-dependencies: - dependency-name: shell-quote dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* | Adding acknowledgement to org-parser.Yuchen Pei2022-07-201-0/+4
| |
* | wordingYuchen Pei2022-07-191-4/+4
| |
* | typoYuchen Pei2022-07-191-1/+1
| |
* | updating readmeYuchen Pei2022-07-191-12/+16
| |
* | Updating README and adding a symlink to itYuchen Pei2022-07-181-1/+7
| |
* | updated README with real linksYuchen Pei2022-07-182-9/+10
| |
* | Preparing for publication.Yuchen Pei2022-07-188-18/+846
| | | | | | | | | | | | - license - cabal - readme
* | a hole in fieldoccYuchen Pei2022-07-181-0/+1
| |
* | removing hackage url for idsYuchen Pei2022-07-181-19/+7
| |
* | Adding hackage url to top level decl propertiesYuchen Pei2022-07-182-20/+38
| |
* | Adding org backend.Yuchen Pei2022-07-185-221/+1591
|/
* Fix #783 Don't show button if --quickjump not presentMike Pilgrem2022-06-127-3192/+2199
|
* Render module tree per package in the content page (#1492)Marcin Szamotulski2022-06-074-53/+199
| | | | | | | | | | | | | * Render module tree per package in the content page When rendering content page for multiple packages it is useful to split the module tree per package. Package names in this patch are inferred from haddock's interface file names. * Write PackageInfo into interface file To keep interface file format backward compatible, instead of using `Binary` instance for `InterfaceFile` we introduce functions to serialise and deserialise, which depends on the interface file version.
* Use visibility to decide which interfaces are included in quickjump (#1490)Marcin Szamotulski2022-05-251-1/+4
| | | | This is also consistent with how html index is build. See haskell/cabal#7669 for rationale behind this decision.
* Version bump 2.26.1 (#1489)Marcin Szamotulski2022-05-251-1/+1
| | | | | | | | * Version bump 2.26.1 We extended format accepted by `--read-interface` option, which requires updating the minor version. * Update documentation of --read-interface option
* Check if doc-index.json exists before reading it (#1488)Marcin Szamotulski2022-05-241-4/+9
|
* Allow to hide interfaces when rendering multiple components (#1487)Marcin Szamotulski2022-05-212-23/+38
| | | | | This is useful when one wishes to `--gen-contents` when rendering multiple components, but one does not want to render all modules. This is in particular useful when adding base package.
* Hide synopsis from search when hidden (#1486)Xia Li-yao2022-05-201-0/+4
| | | Fix #1451
* Fix the changelog and bump the version of haddock-library on ghc-9.2Hécate Moonlight2022-05-081-2/+2
|
* Fix hyperlinks to external items and modules (#1482)Jade Lovelace2022-05-071-4/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes #1481. There were two bugs in this: * We were assuming that we were always getting a relative path to the module in question, while Nix gives us file:// URLs sometimes. This change checks for those and stops prepending `..` to them. * We were not linking to the file under the module. This seems to have been a regression introduced by #977. That is, the URLs were going to something like file:///nix/store/3bwbsy0llxxn1pixx3ll02alln56ivxy-ghc-9.0.2-doc/share/doc/ghc/html/libraries/base-4.15.1.0/src which does not have the appropriate HTML file or fragment for the item in question at the end. There is a remaining instance of the latter bug, but not in the hyperlinker: the source links to items reexported from other modules are also not including the correct file name. e.g. the reexport of Entity in esqueleto, from persistent. NOTE: This needs to get tested with relative-path located modules. It seems correct for Nix based on my testing. Testing strategy: ``` nix-shell '<nixpkgs>' --pure -A haskell.packages.ghc922.aeson mkdir /tmp/aesonbuild && cd /tmp/aesonbuild export out=/tmp/aesonbuild/out genericBuild ln -sf $HOME/co/haddock/haddock-api/resources . ./Setup haddock --with-haddock=$HOME/path/to/haddock/exec --hyperlink-source ```
* Keep track of ordered list indexes and render them (#1407)Ben Simms2022-05-035-6/+15
| | | | | * 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-037-7/+2
|
* Follow hlint suggestion to remove redundant bang. (#1479)Phil de Joux2022-05-031-1/+1
|
* Remove unused imports that GHC warned about. (#1480)Phil de Joux2022-05-032-4/+0
|
* Add hlint action .hlint.yaml with ignores & CPP. (#1475)Phil de Joux2022-05-022-0/+3
|
* Bump copy-props from 2.0.4 to 2.0.5 in /haddock-api/resources/html (#1468)dependabot[bot]2022-04-121-10/+27
| | | | | | | | | | | | | | | | Bumps [copy-props](https://github.com/gulpjs/copy-props) from 2.0.4 to 2.0.5. - [Release notes](https://github.com/gulpjs/copy-props/releases) - [Changelog](https://github.com/gulpjs/copy-props/blob/master/CHANGELOG.md) - [Commits](https://github.com/gulpjs/copy-props/compare/2.0.4...2.0.5) --- updated-dependencies: - dependency-name: copy-props dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Bump path-parse from 1.0.5 to 1.0.7 in /haddock-api/resources/html (#1469)dependabot[bot]2022-04-121-172/+237
| | | | | | | | | | | | | | | Bumps [path-parse](https://github.com/jbgutierrez/path-parse) from 1.0.5 to 1.0.7. - [Release notes](https://github.com/jbgutierrez/path-parse/releases) - [Commits](https://github.com/jbgutierrez/path-parse/commits/v1.0.7) --- updated-dependencies: - dependency-name: path-parse dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* spelling errors (#1471)askeblad2022-04-065-7/+7
|
* Make links in Synopsis functional again (#1458)Steve Hart2022-03-252-2/+1
| | | | | | | | | Commit e41c1cbe9f0476997eac7b4a3f17cbc6b2262faf added a call to e.preventDefault() when handling click events that reach a toggle element. This prevents the browser from following hyperlinks within the Synopsis section when they are clicked by a user. This commit restores functioning hyperlinks within the Synopsis section by removing the call to e.preventDefault(), as it does not appear to be necessary, and removing it increases the flexibility of the details-helper code.
* typos (#1464)askeblad2022-03-166-6/+6
|
* fix CI for 9.2 (#1436)Artem Pelenitsyn2021-11-272-3/+2
|
* coot/multiple packages (ghc-9.2) (#1418)Marcin Szamotulski2021-08-0812-118/+7000
|
* Merge commit '2a966c8ca37' into HEADBen Gamari2021-08-061-2/+2
|\
| * EPA: match changes from GHC T19834Alan Zimmerman2021-07-281-2/+2
| | | | | | | | (cherry picked from commit 2fec1b44e0ee7e263286709aa528b4ecb99ac6c2)
* | Add page about common errors (#1396)CGenie2021-05-311-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Update index.rst Common errors page * Create common-errors.rst * Update common-errors.rst * Use GHC 9.2 in CI runner (#1378) * [haddock-api] remove .hspec-failures Co-authored-by: Hécate Moonlight <Kleidukos@users.noreply.github.com>
* | Use GHC 9.2 in CI runner (#1378)Hécate Moonlight2021-05-282-6/+8
|/
* Update for EPA changes in GHCAlan Zimmerman2021-04-192-25/+25
| | | | (cherry picked from commit cafb48118f7c111020663776845897e225607b41)
* EPA : Rename ApiAnn to EpAnnAlan Zimmerman2021-03-292-28/+25
|
* Bump GHC version to 9.2Ben Gamari2021-03-221-1/+1
|
* Match changes in GHC AST for in-tree API AnnotationsAlan Zimmerman2021-03-1517-336/+387
| | | | As landed via https://gitlab.haskell.org/ghc/ghc/-/merge_requests/2418
* Implement template-haskell's putDocLuke Lau2021-03-102-12/+47
| | | | | | | | | This catches up to GHC using the new extractTHDocs function, which returns documentation added via the putDoc function (provided it was compiled with Opt_Haddock). Since it's already a map from names -> docs, there's no need to do traversal etc. It also matches the change from the argument map being made an IntMap rather than a Map Int