Skip to content
This repository was archived by the owner on Aug 3, 2024. It is now read-only.

Commit 5996cca

Browse files
authored
Update README.md
1 parent cf4b596 commit 5996cca

File tree

1 file changed

+5
-30
lines changed

1 file changed

+5
-30
lines changed

README.md

+5-30
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,9 @@
1-
# Haddock [![CI][CI badge]][CI page] [![Hackage][Hackage badge]][Hackage page]
1+
# Haddock
22

3-
Haddock is the standard tool for generating documentation from Haskell code.
4-
Full documentation about Haddock itself can be found in the `doc/` subdirectory,
5-
in [reStructuredText][reST] format.
3+
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.
64

7-
## Project overview
5+
Issues and PRs will be transfered to the Haskell gitlab. Please refrain from opening new tickets and PRs here.
86

9-
This project consists of three packages:
7+
Ask questions and chat with us at https://matrix.to/#/#haddock:matrix.org.
108

11-
* `haddock`: provides the `haddock` executable. It is implemented as a tiny
12-
wrapper around `haddock-api`'s `Documentation.Haddock.haddock` function.
13-
14-
* `haddock-api`: contains the program logic of the `haddock` tool.
15-
[The haddocks for the `Documentation.Haddock` module][Documentation.Haddock]
16-
offer a good overview of the functionality.
17-
18-
* `haddock-library`: is concerned with the parsing and processing of the
19-
Haddock markup language. Unlike the other packages, it is expected to build
20-
on a fairly wide range of GHC versions.
21-
22-
## Contributing
23-
24-
See [CONTRIBUTING.md](CONTRIBUTING.md) to see how to make contributions to the
25-
project.
26-
27-
28-
[CI page]: https://github.com/haskell/haddock/actions/workflows/ci.yml
29-
[CI badge]: https://github.com/haskell/haddock/actions/workflows/ci.yml/badge.svg
30-
[Hackage page]: https://hackage.haskell.org/package/haddock
31-
[Hackage badge]: https://img.shields.io/hackage/v/haddock.svg
32-
[reST]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
33-
[Documentation.Haddock]: http://hackage.haskell.org/package/haddock-api/docs/Documentation-Haddock.html
34-
[cabal v2]: https://cabal.readthedocs.io/en/latest/nix-local-build-overview.html
9+
Thank you for your understanding.

0 commit comments

Comments
 (0)