haskell / haskell/cabal

Auto-generate reference documentation for cabal-install in reSt format

Open
#3,856 1 comment 0 reactions 0 assignees View on GitHub
documentation GSoC project candidate old-milestone: ⊥ type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

`cabal-install` has an auto-generated manpage these days (see #2877 -- thanks @mmakowski!). It would be nice if we could use the same amazing technology to also generate a reference page in reSt format to be included as part of our Sphinx documentation. This likely necessitates moving `Cabal/doc` to `cabal-install/doc`. Once this is implemented, next logical attack vectors are auto-generated reference pages for `~/.cabal/config` and the package description format.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.