docs: change to use __HADDOCK_VERSION__ macro instead of __HADDOCK__,…

… as the former is automatically defined by cabal
j-mie6 · Nov 29, 2024 · 4e88324 · 4e88324
1 parent ef4671c
commit 4e88324
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 12 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -60,10 +60,7 @@ jobs:
           cabal test $CONFIG --test-options="--color always"
 
       - name: Doc
-      # Define the `__HADDOCK__` C macro only for the documentation generation.
-      # This is used when generating the type-specialised docs, but allows
-      # the actual haskell library to export the non-specialised versions.
-        run: cabal haddock gigaparsec --haddock-options=--optghc=-cpp --haddock-options=--optghc=-D__HADDOCK__ $CONFIG
+        run: cabal haddock gigaparsec
 
   deploy:
     name: Deploy Docs
@@ -99,7 +96,7 @@ jobs:
             ${{ runner.os }}-${{ matrix.ghc }}-${{ matrix.cabal }}-
 
       - name: Doc
-        run: cabal haddock gigaparsec --enable-doc --haddock-hyperlink-source --haddock-quickjump --haddock-html-location='https://hackage.haskell.org/package/$pkg-$version/docs' --haddock-options=--optghc=-cpp --haddock-options=--optghc=-D__HADDOCK__
+        run: cabal haddock gigaparsec --enable-doc --haddock-hyperlink-source --haddock-quickjump --haddock-html-location='https://hackage.haskell.org/package/$pkg-$version/docs'
 
       - name: Prepare to upload built htmls
         run: cp -r ./$(find dist-newstyle -path '*/doc/html/gigaparsec') site

diff --git a/generate-haddock b/generate-haddock
diff --git a/src/Text/Gigaparsec.hs b/src/Text/Gigaparsec.hs
@@ -100,7 +100,7 @@ import Text.Gigaparsec.Errors.ErrorGen (vanillaGen)
 
 -- We want to improve the docs for Applicative, so we do some trickery with redefinitions 
 --  *only* for the haddock generation.
-#ifdef __HADDOCK__
+#ifdef __HADDOCK_VERSION__
 {-# LANGUAGE NoImplicitPrelude #-}
 import Prelude hiding ((<$>), (<$), (<*>), (*>), (<*), pure, liftA2)
 import Prelude qualified
@@ -574,7 +574,7 @@ We use some C++ macro stuff to only redefine these re-exports for the gigaparsec
 which lets us provide more descriptive (and specialised) documentation for combinators.
 -}
 
-#ifdef __HADDOCK__
+#ifdef __HADDOCK_VERSION__
 {-|
 Repeatedly parse the given parser __zero__ or more times, collecting the results into a list.