Каковы возможности, если таковые имеются, для получения офлайн-документации для основных библиотек Haskell (и, возможно, большего количества)?
Иногда я беру свой ноутбук в кофейню, где нет Wi-Fi, и было бы неплохо иметь что-то вроде Hoogle, но для автономного использования.
Ответы:
Hoogle доступен в автономном режиме, его можно установить из Cabal: http://hackage.haskell.org/package/hoogle
Инструкции по использованию находятся на странице http://www.haskell.org/haskellwiki/Hoogle#Command_Line_Search_Flags .
Применение:
$ hoogle --help
Hoogle v4.2.8, (C) Neil Mitchell 2004-2011
http://haskell.org/hoogle
hoogle [COMMAND] ... [OPTIONS]
Commands:
[search] Perform a search
data Generate Hoogle databases
server Start a Hoogle server
combine Combine multiple databases into one
convert Convert an input file to a database
test Run tests
dump Dump sections of a database to stdout
rank Generate ranking information
log Analyse log files
Common flags:
-? --help Display help message
-V --version Print version information
-v --verbose Loud verbosity
-q --quiet Quiet verbosity
Создайте базу данных по умолчанию с помощью hoogle data(подробнее см. Http://neilmitchell.blogspot.com/2008/08/hoogle-database-generation.html ).
РЕДАКТИРОВАТЬ: сеанс использования после локальной установки Hoogle:
$ hoogle
No query entered
Try --help for command line options
$ hoogle data
(downloads databases...takes a few minutes)
Здесь я столкнулся с ошибкой ... очевидно, это связано с версией Кабала, поэтому я обновил ее (http://hackage.haskell.org/trac/hackage/ticket/811). Это не помогло, поэтому я запустил hoogle data all, что отменил, так как это занимало так много времени (кажется, проходит через все пакеты на Hackage). Он по-прежнему не разрешил бы такой запрос, hoogle mapно разрешил hoogle map +base(т.е. ограничил поискbase пакетом). Надеюсь, это сработает для вас!
EDIT2: похоже, это решает проблему (для меня):
$cd .cabal/share/hoogle-4.2.8/databases
$hoogle combine base.hoo
$hoogle foldl\'
Data.List foldl' :: (a -> b -> a) -> a -> [b] -> a
Data.Foldable foldl' :: Foldable t => (a -> b -> a) -> a -> t b -> a
hoogle data --localмне потребовалось 3 минуты (большая часть которых была загружена). Затем я могу запустить программу, hoogle foldlкоторая находит функцию foldl, или hoogle server --localзатем посетить, http://localhost/который одновременно является полноценным сервером и включает ссылки на документацию HTML.
hoogle data allи hoogle data --localделать / скачивать много чего, но он все еще не позволяет мне находить функции в пакетах (например, parseFileWithMode). Это должно работать?
hoogle +haskell-src-exts parseFile
hoogle server --localнужно больше наглядности. Это аналог, например godoc -http.
Документацию HTML можно загрузить .tar.bz2с веб-сайта Haskell:
https://downloads.haskell.org/~ghc/latest/docs/
Я только что скачал https://www.haskell.org/ghc/docs/7.6.3/libraries.html.tar.bz2, и это именно то, на что я надеялся.
Есть также другие варианты, такие как Dash и Zeal , см. Также эту ветку Reddit .
hoogle server --local
Если вы устанавливаете платформу Haskell, она включает в себя документы GHC и библиотеки GHC (которые охватывают основные библиотеки). В Windows они находятся в меню «Пуск» в разделе «Все программы | Платформа Haskell».
haskell-platform-docвы можете установить.
Отредактируйте ваш файл ~ / .cabal / config. Найдите строку (возможно, закомментированную), в которой говорится documentation: False. Измените эту строку на documentation: Trueи раскомментируйте ее. Теперь при построении проектов cabal installдокументация также будет собираться и сохраняться локально.
Посмотрите еще немного в том же файле конфигурации, и вы найдете такие параметры, как doc-index-file, docdir, datadir, prefix и т. Д., Которые позволяют вам настроить, где хранится документация.
Возможно, это не «канонический» сам по себе, но я считаю, что наиболее полезным вариантом является программное обеспечение docset, такое как dash (OS X) / zeal + сгенерированные наборы документов. Таким образом, вы получите бесплатный поиск, а также сможете создавать свои собственные наборы документов. Получить «базовую» документацию по пикше для любого из проектов - не проблема. Вы можете создавать собственные наборы документов с помощью haddocset или dash-haskell . Кроме того, он прекрасно интегрируется с редакторами emacs / vim / другими, позволяет вам иметь наборы документации на основе проектов (таким образом у вас будут соответствующие версии для каждого проекта, забудьте обо всех этих хлопотах с локальным хулиганом!) ограничить вас любым потоком сборки, который вы можете иметь.
Если вы создаете свой проект с помощью, которое cabal-installвы можете установить documentation: Trueв своем ~/.cabal/config, а затем переустановите зависимости, чтобы генерировать пикши локально.
Если вы используете стек , вы можете использовать stack haddockкоманду для построения ваших зависимостей и проекта со сгенерированными пикшами.
Я использую devdocs.io , в нем есть документация для многих языков и библиотек (включая Haskell) и есть автономный режим.
Если вы используете производный от Debian дистрибутив и его пакеты, вы найдете объединенную документацию по всем установленным пакетам Haskell (если вы также установите libghc-foo-docпакеты) по адресу
file:///usr/share/doc/ghc-doc/html/libraries/index.html
Кроме того, libghc-foo-docпакеты содержат файлы, необходимые для hoogle, поэтому, если вы apt-get install hoogle, то сразу же сможете использовать их hoogleдля поиска по всем установленным таким образом библиотекам.
documentation: Trueв свой~/.cabal/configфайл, а затем переустановив эти пакеты с помощьюcabal install world --reinstall.