This repository has been archived by the owner on Aug 3, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 239
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
5 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,9 @@ | ||
# Haddock [![CI][CI badge]][CI page] [![Hackage][Hackage badge]][Hackage page] | ||
# Haddock | ||
|
||
Haddock is the standard tool for generating documentation from Haskell code. | ||
Full documentation about Haddock itself can be found in the `doc/` subdirectory, | ||
in [reStructuredText][reST] format. | ||
This repository used to host the Haskell documentation generation tool Haddock, which know lives at: https://gitlab.haskell.org/ghc/ghc/-/tree/master/utils/haddock. | ||
|
||
## Project overview | ||
Issues and PRs will be transfered to the Haskell gitlab. Please refrain from opening new tickets and PRs here. | ||
|
||
This project consists of three packages: | ||
Ask questions and chat with us at https://matrix.to/#/#haddock:matrix.org. | ||
|
||
* `haddock`: provides the `haddock` executable. It is implemented as a tiny | ||
wrapper around `haddock-api`'s `Documentation.Haddock.haddock` function. | ||
|
||
* `haddock-api`: contains the program logic of the `haddock` tool. | ||
[The haddocks for the `Documentation.Haddock` module][Documentation.Haddock] | ||
offer a good overview of the functionality. | ||
|
||
* `haddock-library`: is concerned with the parsing and processing of the | ||
Haddock markup language. Unlike the other packages, it is expected to build | ||
on a fairly wide range of GHC versions. | ||
|
||
## Contributing | ||
|
||
See [CONTRIBUTING.md](CONTRIBUTING.md) to see how to make contributions to the | ||
project. | ||
|
||
|
||
[CI page]: https://github.com/haskell/haddock/actions/workflows/ci.yml | ||
[CI badge]: https://github.com/haskell/haddock/actions/workflows/ci.yml/badge.svg | ||
[Hackage page]: https://hackage.haskell.org/package/haddock | ||
[Hackage badge]: https://img.shields.io/hackage/v/haddock.svg | ||
[reST]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html | ||
[Documentation.Haddock]: http://hackage.haskell.org/package/haddock-api/docs/Documentation-Haddock.html | ||
[cabal v2]: https://cabal.readthedocs.io/en/latest/nix-local-build-overview.html | ||
Thank you for your understanding. |