Использование Cabal для создания документов

Question

Я потерялся. Я не понимаю, как я генерирую документы локально с Cabal. Я хочу, чтобы cabal установил gtk3, который также генерирует документацию. Или хорошо, если это не работает, как я могу генерировать документы локально?

Я поместил это в мой файл.config из cabal: - документация: True

Но не хороший конец, никаких документов не найти

Я думаю, что это простая вещь, которую я просто не вижу....

Хорошо, с помощью некоторых комментариев я получил немного дальше. В любом случае, cabal просто выполняет локальную установку для меня как пользователя и предупреждает, что глобальная установка не рекомендуется. Здесь я нашел https://wiki.haskell.org/Cabal-Install

что я должен сделать для глобальной установки и тому подобное, но если я не использую его, я получаю предупреждения о том, что глобальные не должны использоваться, и даже с набором документации делать документацию: Правда, я не получаю обновление для haskell Платформа документов.

Так что я не должен использовать cabal для глобальной установки файлов?

Answer 1

Я верю, что вы ищете cabal haddock или если вы используете новые команды, cabal new-haddock, Заметим:

% cabal unpack gps
Unpacking to gps-1.2/
% cd gps-1.2
% cabal --help | grep document
  upload           Uploads source packages or documentation to Hackage.
  haddock          Generate Haddock HTML documentation.
  new-haddock      Build Haddock documentation
% cabal haddock
Resolving dependencies...
Configuring gps-1.2...
Preprocessing library for gps-1.2..
Running Haddock on library for gps-1.2..
... snip ...
Documentation created: dist/doc/html/gps/index.html
cabal haddock  3.42s user 1.00s system 92% cpu 4.784 total

Answer 2

Ну, это заняло у меня некоторое время, и некоторые посты указали мне правильное направление.

Сначала моя вина. Я заменил False на True в документации, но не раскомментировал строку, поэтому по умолчанию имел место не генерировать документы (не могу расценить это как хорошее значение по умолчанию - YMMV)

Тогда cabal работает локально нормально, есть флаг --global, чтобы изменить это, или вы можете изменить int в ~/.cabal/config

Теперь то, что происходит с документацией, следующее. Документ создается в домашнем каталоге, но все документы связаны с новым genarated файлом index.html. Таким образом, вы получаете документы из глобальной установки и из локальной установки.

Теперь я все еще не получаю несколько вещей. Я не знаю, почему Cabal не предполагается использовать во всем мире для установки всего филе в глобальном местоположении.

И да, я наткнулся на стек, песочницы и new-xxxx (команды). Я до сих пор не знаю, что из них сделать... Но я думаю, это другой вопрос.