Как использовать luadoc в Ubuntu/ Linux?

Question

Как видно из названия, как использовать 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

Answer 1

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

luadoc file.lua

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

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

luadoc file.lua -d ~/Docs

Насколько я могу видеть, мало что еще можно объяснить о реальных опциях (поскольку ваш фрагмент кода объясняет, что они делают достаточно хорошо).

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

sudo apt-get install luadoc

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

./luadoc

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

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

luadoc file.lua

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