hdocs: Haskell docs tool

[ bsd3, development, library, program ] [ Propose Tags ]

Tool and library to get docs for installed packages and source files. Can return result in JSON format. Can dump docs for all installed modules

Usage:
hdocs module - get docs for module/file
hdocs module name - get docs for name in module/file
hdocs dump [r] - dump all installed docs, if [r], find docs for reexported declarations
flags
-g GHC_OPT  --ghc=GHC_OPT  option to pass to GHC
Versions [faq] 0.1.0.0, 0.2.0.0, 0.3.0.0, 0.3.0.1, 0.4.0.0, 0.4.0.1, 0.4.0.2, 0.4.0.3, 0.4.0.4, 0.4.1.0, 0.4.1.1, 0.4.1.2, 0.4.1.3, 0.4.2.0, 0.4.2.1, 0.4.3.0, 0.4.4.0, 0.4.4.1, 0.4.4.2, 0.5.0.0, 0.5.0.1, 0.5.0.2, 0.5.1.0, 0.5.2.0, 0.5.2.1, 0.5.3.0, 0.5.3.1, 0.5.3.2, 0.5.4.0
Dependencies aeson (>=0.7.0), aeson-pretty (>=0.7.0), base (>=4.7 && <5), bytestring (>=0.10.0), Cabal (>=1.22.2), containers (>=0.5.0), filepath (>=1.3.0), ghc (>=7.8.1), ghc-paths (>=0.1.0), haddock-api, haddock-library (==1.2.* || ==1.4.* || >=1.6 && <1.9), hdocs, mtl (>=2.1.0), network (>=2.4.0), process (>=1.2.0), text (>=1.1.0) [details]
License BSD-3-Clause
Author Alexandr `Voidex` Ruchkin
Maintainer voidex@live.com
Category Development
Home page https://github.com/mvoidex/hdocs
Source repo head: git clone git://github.com/mvoidex/hdocs.git
Uploaded by AlexandrRuchkin at Mon Oct 7 03:19:15 UTC 2019
Distributions NixOS:0.5.4.0
Executables hdocs
Downloads 16827 total (846 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2019-10-07 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees