Proxmox/pve-docs
5
0
Fork 0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-24 02:03:59 +03:00
Code Releases Activity

improve Makefile: add phony target 'index'

Browse Source 
You can now simply use "make index" to generate and viw all docs.
This commit is contained in:
Dietmar Maurer 2016-04-30 11:13:12 +02:00
parent b564343698
commit 8ace711099
3 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Makefile
View File

@ -165,12 +165,15 @@ pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
test -n "$${NOVIEW}" || $(BROWSER) $@ &
.PHONY: index
index: index.html
test -n "$${NOVIEW}" || $(BROWSER) index.html &
index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
$(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
$(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
$(MAKE) NOVIEW=1 $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST}))
asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
test -n "$${NOVIEW}" || $(BROWSER) index.html &
pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
asciidoc -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
@ -217,10 +220,7 @@ DOC_DEB_FILES= \
pve-admin-guide.epub \
index.html
${DOC_DEB}: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
$(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
$(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
${DOC_DEB}: index.html
rm -rf build
mkdir build
rsync -a doc-debian/ build/debian

18
README.adoc
View File

@ -19,11 +19,21 @@ To simplify the documentation task, we keep all Documentation within
this repository. It is possible to generate the docs (without installing
any additional Proxmox packages) with:
make index.html
make index
We also generate an additional development package called
'pve-doc-generator', which is used by other Proxmox VE package to
generate manual pages at package build time.
Debian Packages
---------------
We generate a development package called 'pve-doc-generator', which is
used by other Proxmox VE package to generate manual pages at package
build time.
Another package called 'pve-docs' is used to publish generated
'.html' and '.pdf' files on our web servers. You can generate
those debian packages using:
make deb
Common Macro definition in link:attributes.txt[]

1
pve-admin-guide.adoc
View File

@ -58,6 +58,7 @@ include::pveceph.adoc[]
include::pvesubscription.adoc[]
:leveloffset: 1
include::pve-faq.adoc[]