Как да използвам 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: във функция 'start' /usr/share/lua/5.1/luadoc/init.lua:49: във функция ‹/usr/share/lua/5.1/luadoc/init.lua:26› (опашно повикване): ? /usr/bin/luadoc:121: в основния блок [C]: ?   -  person Chhabilal    schedule 05.07.2013
comment
да, Мегц, може би си прав... но би било хубаво, ако ти/някой, който е успял да генерира 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 Не, коя е използваната команда, която даде тази грешка?   -  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

което означава, че вашият 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