asciidoc: moved support files into doc/
Docs should live happily together, after all, and toplevel should be more or less uncluttered :) Adjusted/rewrote as appropriate as well.
This commit is contained in:
parent
ccf3b2220a
commit
4e0cd6bdf6
3
Makefile
3
Makefile
@ -61,3 +61,6 @@ SHELL = /bin/bash
|
||||
fi; \
|
||||
done; \
|
||||
if [ "$$n" -lt "$(NUM_TARGETS)" ]; then say; fi
|
||||
|
||||
docs:
|
||||
@$(MAKE) -C doc
|
||||
|
@ -1,14 +0,0 @@
|
||||
== Генерация документации ==
|
||||
|
||||
Необходимые пакеты:
|
||||
apt-get install asciidoc-a2x xmlgraphics* fonts-ttf-ms
|
||||
Внимание! Пакеты весьма увесисты (около гигабайта), имейте ввиду.
|
||||
|
||||
Для генерации текущей документации посредством ASCIIDOC выполнить:
|
||||
для pdf-версии
|
||||
make -f Makefile.asciidoc -d pdf
|
||||
для html-версии
|
||||
make -f Makefile.asciidoc -d
|
||||
|
||||
Сгенерируются соответственно mkimage-profiles.pdf или mkimage-profiles.html
|
||||
Опция -d для детального вывода, необязательна.
|
@ -1,7 +1,7 @@
|
||||
PROJECT = mkimage-profiles
|
||||
TOPLEVEL_DOC = mkimage-profiles.asciidoc
|
||||
HTMLPAGE = $(TOPLEVEL_DOC:.asciidoc=.html)
|
||||
RESOURCE_FILES = /etc/asciidoc/
|
||||
RESOURCE_FILES = /etc/asciidoc
|
||||
|
||||
A2X = a2x
|
||||
|
||||
@ -11,18 +11,18 @@ all: $(HTMLPAGE)
|
||||
|
||||
%.html: %.asciidoc
|
||||
$(A2X) -d book -f xhtml -a lang=ru \
|
||||
--icons -r $(RESOURCE_FILES) -r ./ \
|
||||
--icons -r $(RESOURCE_FILES) -r . \
|
||||
--xsltproc-opts='--stringparam toc.max.depth 3' \
|
||||
$<
|
||||
|
||||
chunked: $(TOPLEVEL_DOC)
|
||||
$(A2X) -d book -f chunked -a lang=ru \
|
||||
--icons -r /etc/asciidoc/ -r ./ \
|
||||
--icons -r $(RESOURCE_FILES) -r . \
|
||||
--xsltproc-opts='--stringparam toc.max.depth 3' \
|
||||
$<
|
||||
|
||||
pdf: $(TOPLEVEL_DOC)
|
||||
$(A2X) --verbose --fop --fop-opts='-c fop.xconf' -d book -f pdf -a lang=ru \
|
||||
$(A2X) --verbose --fop --fop-opts='-c .fop.xconf' -d book -f pdf -a lang=ru \
|
||||
--xsltproc-opts=' \
|
||||
--stringparam toc.max.depth 3 \
|
||||
--stringparam title.font.family "Arial" \
|
@ -1,5 +1,4 @@
|
||||
|
||||
*Предположения фрагментов кода об окружении*
|
||||
== Предположения фрагментов кода об окружении ==
|
||||
|
||||
NB: пути приводятся от верхнего уровня; проект в целом предполагает
|
||||
ALT Linux 6.0+ и GNU make 3.81 (на которых и разрабатывается),
|
||||
|
16
doc/gen-asciidoc.txt
Normal file
16
doc/gen-asciidoc.txt
Normal file
@ -0,0 +1,16 @@
|
||||
== Генерация документации ==
|
||||
|
||||
При желании сгенерировать PDF устанавливаем необходимые пакеты:
|
||||
# apt-get install asciidoc-a2x xmlgraphics-fop fonts-ttf-dejavu
|
||||
|
||||
// Внимание! FOP со всем нужным весьма увесист (несколько сот мегабайт).
|
||||
|
||||
Для генерации текущей документации посредством ASCIIDOC выполнить по вкусу:
|
||||
$ make pdf
|
||||
$ make xhtml
|
||||
|
||||
Сгенерируются соответственно mkimage-profiles.pdf или mkimage-profiles.html
|
||||
(в текущем каталоге либо BUILDDIR, если задан).
|
||||
|
||||
Для очистки:
|
||||
$ make clean
|
@ -1,11 +1,12 @@
|
||||
= mkimage-profiles =
|
||||
Michael Shigorin <mike@altlinux.org>
|
||||
:DocVersion: v0.1.0
|
||||
:DocVersion: v0.2.0
|
||||
:DocDate: Oct 2012
|
||||
|
||||
= Введение =
|
||||
|
||||
mkimage-profiles, или m-p — результат осмысления и обобщения опыта создания семейств дистрибутивов.
|
||||
mkimage-profiles, или m-p — результат осмысления и обобщения опыта создания
|
||||
семейств дистрибутивов свободного программного обеспечения на базе ALT Linux.
|
||||
|
||||
*Цели*
|
||||
|
||||
@ -30,45 +31,43 @@ mkimage-profiles, или m-p — результат осмысления и об
|
||||
cd mkimage-profiles
|
||||
make distro/icewm.iso
|
||||
|
||||
include::README[]
|
||||
include::../README[]
|
||||
|
||||
= Основы =
|
||||
|
||||
== Предположения об окружении ==
|
||||
include::assumptions.txt[]
|
||||
|
||||
include::doc/assumptions.txt[]
|
||||
include::debug.txt[]
|
||||
|
||||
include::doc/debug.txt[]
|
||||
include::features.txt[]
|
||||
|
||||
include::doc/features.txt[]
|
||||
include::params.txt[]
|
||||
|
||||
include::doc/params.txt[]
|
||||
include::pkglists.txt[]
|
||||
|
||||
include::doc/pkglists.txt[]
|
||||
include::qemu.txt[]
|
||||
|
||||
include::doc/qemu.txt[]
|
||||
include::style.txt[]
|
||||
|
||||
include::doc/style.txt[]
|
||||
|
||||
include::doc/vm.txt[]
|
||||
include::vm.txt[]
|
||||
|
||||
|
||||
= Каталоги =
|
||||
|
||||
include::conf.d/README[]
|
||||
include::../conf.d/README[]
|
||||
|
||||
include::features.in/README[]
|
||||
include::../features.in/README[]
|
||||
|
||||
include::image.in/README[]
|
||||
include::../image.in/README[]
|
||||
|
||||
include::lib/README[]
|
||||
include::../lib/README[]
|
||||
|
||||
include::pkg.in/README[]
|
||||
include::../pkg.in/README[]
|
||||
|
||||
include::sub.in/README[]
|
||||
include::../sub.in/README[]
|
||||
|
||||
include::sub.in/main/README[]
|
||||
include::../sub.in/main/README[]
|
||||
|
||||
include::sub.in/stage1/README[]
|
||||
include::../sub.in/stage1/README[]
|
||||
|
||||
include::sub.in/stage2/README[]
|
||||
include::../sub.in/stage2/README[]
|
Loading…
Reference in New Issue
Block a user