valadoc org
1.0.0
Остается хрустящим, даже в молоке.
Этот пакет содержит конструкцию, используемые для генерации valadoc.org, и в идеале не следует использовать для создания других страниц.
Чтобы построить документы, вам понадобятся следующие:
valadoc > = 0,35,0phpНа начальной ОС или Ubuntu Run:
sudo add-apt-repository ppa:vala-team
sudo apt update
sudo apt install valac valadoc libvaladoc-dev unzip php php-curlАрка или производные работают:
pacman -S vala phpДалее установите JS -зависимости:
npm install После того, как вы установили valadoc , вы можете перейти к созданию документации. Просто беги:
make serveЭто займет немного времени, так что возьмите себе чашку кофе; Если вы нетерпеливы, беги:
make serve-mini Для минимальной тестовой версии. Если вы столкнетесь с ошибкой на этом этапе, см. Раздел «Общие ошибки». После того, как вы завершили здание, вы должны увидеть папку valadoc.org .
Чтобы получить доступ к документации, перейдите к вашему браузеру по адресу http: // localhost: 7777.
Чтобы установить документацию Valadoc как Devhelp Books, сначала постройте страницы с любым
make build-docs-mini build-data GENERATOR_OPTS=--skip-existingдля простого, Gio и Gobject, или
make build-docs build-data GENERATOR_OPTS=--skip-existingдля всех пакетов. Это может занять немного больше времени.
После этого вы можете бежать
sudo make installЧтобы установить книги DevHelp в вашей системе. Теперь запустите DeVhelp и используйте их!
Для более полного опыта вам нужно будет установить Mantyore и xsltproc .
На начальной ОС или Ubuntu Run:
sudo apt install xsltprocЗапустите следующую команду для генерации индексов поиска:
make serve-search Это (в конце концов!) Начнет демон Мантикора на порту 51413 .
Откройте documentation/packages.xml и добавьте новый пакет-вход.
Используйте <external-package> для создания внешних ссылок:
< external-package name = " package-name " link = " http://path/to/docs " >
short description
</ external-package > Используйте <package> для создания и включения документации для файлов vapi:
< package name = " gdl-1.0 " >
short description
</ package >Поддерживаются следующие атрибуты:
| Имя | Описание |
|---|---|
| имя | Имя VAPI |
| устарел | Установить его на «true», чтобы отметить пакет как устаревший |
| Содействия | СПИСОК ПРЕДУПРЕЖДЕНИЯ |
| гир | Файл GIR, используемый для извлечения документации из |
| c-docs | Ссылка на документацию C |
| игнорировать | Не строить документацию для этой записи |
| дом | Ссылка на домашнюю страницу |
| флаги | Дополнительные флаги Vala (отсутствующие зависимости, ...) |
| галерея | Ссылка на галерею виджетов GTK-DOC |
| vapi-image-source | Источник для загрузки изображений с |
Ссылка GIR и VAPI-Files должны быть частью одного из следующих репозиториев:
Скопируйте свои примеры в examples/<vapi-name>/ и добавьте новую запись в examples/<vapi-name>/<vapi-name>.valadoc.examples :
< example >
< title >Example Title</ title >
< image >optional-screenshot.png</ image >
< file >file-name-1.vala</ file >
< file >file-name-2.vala</ file >
< compile >valac file-name1.vala file-name-2.vala ...</ compile >
< node >Associated.Symbol.name1</ node >
< node >Associated.Symbol.name2</ node >
</ example > Если это первый пример для пакета, добавьте линию в цель check-examples Makefile .
Создайте новый файл с именем <vapi-name>.valadoc в documentation/<vapi-name>/ :
...
/**
* My valadoc comment
*/
c::c_symbol_name
...
/**
* My valadoc comment
*/
Vala.Symbol.Name
packages.xml , описывающие все пакеты. Он отвечает за создание страницы. Он получает ресурсы, такие как изображения из указанных источников, вычисляет валадок-звонки, создает документацию для указанных пакетов и размещает всю страницу. ( make serve , make serve-mini )make test-examples ) Uncaught Error: Class 'mysqli' not found
extension=mysqli.so в php.ini вашей ОС ( find /etc -name php.ini ) error: failed to load driver
VALAC_VERSION в Makefile.Другие ошибки:
LOG в корне этого репо для получения дополнительной информации
