Как использовать luadoc в ubuntu / linux?

Как говорится в заголовке, Как использовать luadoc в ubuntu / linux? Я сгенерировал документацию в windows с помощью пакетного файла, но без успеха в ubuntu. Есть идеи?

luadoc
Usage: /usr/bin/luadoc [options|files]
Generate documentation from files. Available options are:
  -d path                      output directory path
  -t path                      template directory path
  -h, --help                   print this help and exit
      --noindexpage            do not generate global index page
      --nofiles                do not generate documentation for files
      --nomodules              do not generate documentation for modules
      --doclet doclet_module   doclet module to generate output
      --taglet taglet_module   taglet module to parse input code
  -q, --quiet                  suppress all normal output
  -v, --version                print version information
1 3
lua documentation-generation

1 ответ:

Во-первых, у меня мало опыта работы с Luadoc, но много опыта работы с Ubuntu и Lua, поэтому я основываю все свои очки на этих знаниях и быстрой установке, которую я только что сделал с luadoc. Luadoc, насколько я могу видеть, является библиотекой Lua (поэтому может также использоваться в сценариях Lua, а также bash). Чтобы сделать документацию (в bash), вы просто запустите

luadoc file.lua

(где file-имя файла, для которого вы хотите создать документацию)

Варианты-d и-t существуют для выбора куда вы хотите поместить файл и какой шаблон вы хотите использовать (о котором я понятия не имею, боюсь: P). Например (for-d): 

luadoc file.lua -d ~/Docs
Насколько я могу судить, больше нечего объяснять о реальных опциях (поскольку ваш фрагмент кода объясняет, что они делают достаточно хорошо).

Теперь, глядя на ошибки, полученные при запуске (lua5. 1: ... не удалось открыть "индекс.html " для написания), я бы предложил несколько вещей. Во-первых, если вы скомпилировали исходный код, то вы, возможно, сделали ошибка где-то, например, не устанавливать зависимости (чему я был бы удивлен, потому что в противном случае вы бы вообще не смогли этого сделать). Если да, то вы можете попробовать получить его из РЕПО с помощью

sudo apt-get install luadoc

Который также установит зависимости. Это, вероятно, проблема, так как моя рабочая копия luadoc отлично работает из /usr/bin с командой

./luadoc
Это означает, что ваш луадок странный, или вы делаете что-то смешное (что я не могу понять из того, что вы сделали сказанный). Я предполагаю, что у вас установлен lua5.1 (учитывая ошибки), так что это не имеет отношения к этому.

Мой вам совет-попробуйте бежать 

luadoc file.lua

В каталоге файла.lua с любым старым файлом lua (хотя предпочтительно с небольшим количеством данных) и посмотреть, генерирует ли он индекс.html в той же папке (не меняйте каталог с -d, в целях тестирования). Если это не работает, то переустановите его из репозитория с помощью apt-get. Если это и попытка luadoc файл.lua не работает, тогда ответьте с ошибками, так как что-то большее идет не так (вероятно).

2