Skip to content

Docs: haddock-hyperlink-source no longer uses HsColour #12419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SatvikMishra08 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs: haddock-hyperlink-source no longer uses HsColour #12419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions doc/cabal-project-description-file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1838,16 +1838,19 @@ running ``setup haddock``.

:default: False

Generated hyperlinked source code using `HsColour`_, and have
Haddock documentation link to it.
Generate hyperlinked source code and have Haddock documentation
link to it.
This is equivalent to running ``haddock`` with the ``--hyperlinked-source`` flag.
Haddock versions older than 2.17 don't support that flag, so for those
Cabal falls back to generating the source with `HsColour`_.

.. cfg-field:: haddock-hscolour-css: PATH
--haddock-hscolour-css=PATH
:synopsis: Location of CSS file for HsColour

The CSS file that should be used to style the generated hyperlinked
source code (from `HsColour`_).
source code (from `HsColour`_). Only used for the HsColour fallback
with Haddock versions older than 2.17.

.. cfg-field:: haddock-contents-location: URL
--haddock-contents-location=URL
Expand Down
2 changes: 1 addition & 1 deletion doc/references.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

.. _Hoogle: http://www.haskell.org/hoogle/

.. _HsColour: http://www.cs.york.ac.uk/fp/darcs/hscolour/
.. _HsColour: https://hackage.haskell.org/package/hscolour

.. _cpphs: http://projects.haskell.org/cpphs/

Expand Down
Loading