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

lua documentation-generation luadoc
person Chhabilal    schedule 05.07.2013    source источник
comment
Вы пробовали /usr/bin/luadoc [options|files]? Что пошло не так?   -  person Bartek Banachewicz    schedule 05.07.2013
comment
Похоже, это не связано с программированием и, вероятно, лучше подходит либо для askubuntu.com, либо для superuser.com   -  person Mgetz    schedule 05.07.2013
comment
Привет, я пытался, но получаю ошибку: lua5.1: ./luadoc/doclet/html.lua:224: не удалось открыть `index.html' для записи трассировки стека: [C]: в функции 'assert' ./luadoc/ doclet/html.lua:224: в функции «старт» (хвост): ? /usr/bin/luadoc:121: в основном блоке [C]: ?   -  person Chhabilal    schedule 05.07.2013
comment
да, Megtz, возможно, вы правы ... но было бы неплохо, если бы вы / кто-то, кому удалось создать документацию lua на платформе Linux, могли бы подробно объяснить мне, к чему относятся параметры?   -  person Chhabilal    schedule 05.07.2013
comment
и используемая команда, вызвавшая эту ошибку?   -  person greatwolf    schedule 05.07.2013
comment
да, используемая команда дала эту ошибку   -  person Chhabilal    schedule 05.07.2013
comment
Кстати, как вы пишете скрипт запуска luadoc.lua?   -  person Chhabilal    schedule 05.07.2013
comment
@user2554162 user2554162 Нет, какая команда вызвала эту ошибку?   -  person greatwolf    schedule 05.07.2013
comment
Я решил проблему, в любом случае, спасибо, ребята, если кому-то нужна помощь с этой темой, пожалуйста, дайте мне знать.   -  person Chhabilal    schedule 11.07.2013
comment
Я установил его с помощью luarocks под Windows, но где luadocs, чтобы я мог его запустить?   -  person Stefan Falk    schedule 18.12.2016

Ответы (1)


arrow_upward
2
arrow_downward

Во-первых, у меня мало опыта работы с 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

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

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

luadoc file.lua

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

person finnbar    schedule 14.07.2013
comment
@displayname Я не использую Windows, поэтому не знаю. Однако в в этом сообщении что-то есть, хотя оно установлено вместе с Lua для Windows. а не LuaRocks, поэтому я не знаю, полезно ли это. Вероятно, его нет в системном пути или что-то в этом роде, и в этом случае вам придется его как-то добавить (опять же, я не пользователь Windows). - person finnbar; 18.12.2016