aboutsummaryrefslogblamecommitdiff
path: root/haddock-library/haddock-library.cabal
blob: feb98e2fae0d51539a154b04f18b8ecb709b8398 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
                         
                                     
                           
                                                                     
 
                                                                            



                                                                     
                                                                                                     
                                  
                             
                                                                                                                                                                              
                                                     
                                                               
                                   
                                                         
                   
 
                               
                
                                       










                                                                                           
                           
                  
                                
                                
                
                                     
                                      
 
               
                      
                                      

                           
         
 


                
                               
                                  


                                           
                                      
                                 
                








                                                               
 
                     
                                             
 


                                      
                         
                            
                         
                




                                                                
                                       



                                        
                      
                                                  
cabal-version:        2.2
name:                 haddock-library
version:              1.8.0
synopsis:             Library exposing some functionality of Haddock.

description:          Haddock is a documentation-generation tool for Haskell
                      libraries. These modules expose some
                      functionality of it without pulling in the GHC
                      dependency. Please note that the API is likely
                      to change so be sure to specify upper bounds in
                      your projects. For interacting with Haddock
                      itself, see the [haddock package](https://hackage.haskell.org/package/haddock).

license:              BSD-2-Clause
license-files:        LICENSE
maintainer:           Alec Theriault <alec.theriault@gmail.com>, Alex Biehl <alexbiehl@gmail.com>, Simon Hengel <sol@typeful.net>, Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
homepage:             http://www.haskell.org/haddock/
bug-reports:          https://github.com/haskell/haddock/issues
category:             Documentation
tested-with:          GHC==8.10.*, GHC==8.8.1, GHC==8.6.5

extra-source-files:
  CHANGES.md

common lib-defaults
  default-language: Haskell2010

  build-depends:
    , base         >= 4.5     && < 4.15
    , bytestring   ^>= 0.9.2.1 || ^>= 0.10.0.0
    , containers   ^>= 0.4.2.1 || ^>= 0.5.0.0 || ^>= 0.6.0.1
    , transformers ^>= 0.3.0.0 || ^>= 0.4.1.0 || ^>= 0.5.0.0
    , text         ^>= 1.2.3.0
    , parsec       ^>= 3.1.13.0

  ghc-options: -funbox-strict-fields -Wall -fwarn-tabs
  if impl(ghc >= 8.0)
    ghc-options: -Wcompat -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances

library
  import: lib-defaults

  hs-source-dirs:       src

  exposed-modules:
    Documentation.Haddock.Doc
    Documentation.Haddock.Markup
    Documentation.Haddock.Parser
    Documentation.Haddock.Types

  other-modules:
    Documentation.Haddock.Parser.Util
    Documentation.Haddock.Parser.Monad

test-suite spec
  import: lib-defaults
  type:             exitcode-stdio-1.0
  main-is:          Spec.hs
  hs-source-dirs:
      test
      src

  cpp-options:
      -DTEST

  other-modules:
      Documentation.Haddock.Doc
      Documentation.Haddock.Markup
      Documentation.Haddock.Parser
      Documentation.Haddock.Parser.Monad
      Documentation.Haddock.Parser.Util
      Documentation.Haddock.Parser.UtilSpec
      Documentation.Haddock.ParserSpec
      Documentation.Haddock.Types

  build-depends:
    , base-compat  ^>= 0.9.3 || ^>= 0.10.0
    , QuickCheck   ^>= 2.11.3
    , deepseq      ^>= 1.3.0.0 || ^>= 1.4.0.0

  -- NB: build-depends & build-tool-depends have independent
  --     install-plans, so it's best to limit to a single major
  --     version of `hspec` & `hspec-discover` to ensure
  --     intercompatibility
  build-depends:
    , hspec                         ^>= 2.5.5

  build-tool-depends:
    , hspec-discover:hspec-discover ^>= 2.5.5

test-suite fixtures
  type:             exitcode-stdio-1.0
  default-language: Haskell2010
  main-is:          Fixtures.hs
  ghc-options:      -Wall
  hs-source-dirs:   fixtures
  buildable:        False
  build-depends:
      -- intra-package dependency
    , haddock-library
      -- constraints inherited via lib:haddock-library component
    , base

      -- extra dependencies
    , base-compat  >= 0.9.3   && < 0.11
    , directory             ^>= 1.3.0.2
    , filepath              ^>= 1.4.1.2
    , optparse-applicative  ^>= 0.14.0.0
    , tree-diff             ^>= 0.0.0.1

source-repository head
  type:     git
  subdir:   haddock-library
  location: https://github.com/haskell/haddock.git