docidx alternatives and similar packages
Based on the "Documentation" category.
Alternatively, view docidx alternatives based on common mentions on social networks and blogs.
-
-
-
archiver
Background daemon which archives a list of URLs to the Internet Archive, archive.is, and other services
WorkOS - The modern identity platform for B2B SaaS
Do you think we are missing an alternative of docidx or a related project?
README
docidx.hs
docidx.hs - create an HTML index of your installed Haskell packages. The index looks something like this:
Overview
docidx is a small tool which creates an HTML index of your installed
Haskell packages, with links to each package's Haddock docs locally
and on Hackage. While cabal install now creates and maintains an
index "by module", sometimes it's nice to have this other view (and
the quick links to Hackage).
docidx works by querying your global and user package databases (via
ghc-pkg, via the Cabal package) for information on all installed
packages. When ghc-pkg expects Haddock docs to be present, their
local paths are included in this information. Thus docidx builds an
index of all installed packages, including version numbers where more
than one version is present, package synopses, links to the local
Haddock docs, and a link to the package on Hackage.
Packages are grouped by first letter, and there's an A-Z index at the
top of the page, which can be easily extended via a config file to
include extra links you think are handy (e.g. to the per-module index,
to local ghc documentation, to the Haskell report, etc. - whatever
you want).
The distribution includes an example of the output HTML and a partial screenshot of how that page looks..
Installation
Either just use cabal install to pull the latest version from
hackage and install it,
or download the source from the
project home page and
build/install it using the usual cabal mechanism.
Usage
...is very simple:
docidx
on its own will write its output (a single HTML page) to stdout,
whereas:
docidx filename
will attempt to write its output to the specified file.
Warnings and errors (e.g. if Cabal reports that a package has
Haddock docs, but they can't be found/read) go to stderr.
I run it every hour from cron, personally, piping its results to
~/.cabal/share/doc/docidx.html - which I then use as the entry point
for all my Haskell documentation needs.
Configuration
docidx will look for the file config in the application's user
data directory as reported by
System.Directory.getAppUserDataDirectory (so in Unixy systems that's
~/.docidx/config, and in Windows it's probably C:/Documents And
Settings/user/Application Data/docidx/config). docidx runs
perfectly well if that file is absent; it doesn't ever write to it.
An example config file is included in the distribution.
At present the only thing which can be configured this way is the list of extra links in the table of contents. The following could be exposed via the config file, but are also quite easy to change within the program's code:
Which package databases to query. (Maybe a command-line option?)
Page title.
CSS (currently just references hackage's and local version of haddock's).
Favicon (currently uses the hackage package list bullet point).
Other symbols, particularly the "hackage link" arrow (currently some Unicode arrow).
History
Andy Gimblett started the ball rolling with
a python program to index his
global Haddock directory just by crawling the HTML. Andy Price then
ported that to Haskell, and
about a year later Andy Gimblett forked that and pretty much rewrote
it (but keeping some of the HTML processing parts) to query Cabal
for the package information.