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

add api-viewer to index.adoc

Browse Source
This commit is contained in:
Dietmar Maurer 2016-04-29 14:13:12 +02:00
parent 87fc9dc475
commit 356064f40d
5 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Makefile
View File

@ -74,6 +74,10 @@ SYSADMIN_SOURCES= \
system-software-updates.adoc \ system-software-updates.adoc \
sysadmin.adoc sysadmin.adoc
API_VIEWER_SOURCES= \
api-viewer/index.html \
api-viewer/apidoc.js
PVE_ADMIN_GUIDE_SOURCES= \ PVE_ADMIN_GUIDE_SOURCES= \
${DATACENTER_CONF_MAN5_SOURCES} \ ${DATACENTER_CONF_MAN5_SOURCES} \
${QM_CONF_MAN5_SOURCES} \ ${QM_CONF_MAN5_SOURCES} \
@ -140,7 +144,7 @@ pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
test -n "$${NOVIEW}" || $(BROWSER) $@ & test -n "$${NOVIEW}" || $(BROWSER) $@ &
index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} 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 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 .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
@ -159,11 +163,11 @@ pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
a2x -f epub pve-admin-guide.adoc a2x -f epub pve-admin-guide.adoc
test -n "$${NOVIEW}" || $(BROWSER) $@ & test -n "$${NOVIEW}" || $(BROWSER) $@ &
apidata.js: extractapi.pl api-viewer/apidata.js: extractapi.pl
./extractapi.pl >$@ ./extractapi.pl >$@
apidoc.js: apidata.js PVEAPI.js api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
cat apidata.js PVEAPI.js >$@ cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
.PHONY: dinstall .PHONY: dinstall
dinstall: ${GEN_DEB} dinstall: ${GEN_DEB}
@ -185,7 +189,7 @@ DOC_DEB_FILES= \
pve-admin-guide.epub \ pve-admin-guide.epub \
index.html index.html
${DOC_DEB}: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} apidoc.js apidoc.htm ${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 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 .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
@ -197,11 +201,9 @@ ${DOC_DEB}: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} apidoc.js apidoc.htm
echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${DOC_PACKAGE}/SOURCE echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${DOC_PACKAGE}/SOURCE
# install doc files # install doc files
install -m 0644 ${DOC_DEB_FILES} build/usr/share/${DOC_PACKAGE} install -m 0644 ${DOC_DEB_FILES} build/usr/share/${DOC_PACKAGE}
install -m 0644 index.html build/usr/share/${DOC_PACKAGE}
# install api doc viewer # install api doc viewer
mkdir build/usr/share/${DOC_PACKAGE}/pve2-api-doc mkdir build/usr/share/${DOC_PACKAGE}/api-viewer
install -m 0644 apidoc.htm build/usr/share/${DOC_PACKAGE}/pve2-api-doc/index.html install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer
install -m 0644 apidoc.js build/usr/share/${DOC_PACKAGE}/pve2-api-doc/
cd build; dpkg-buildpackage -rfakeroot -b -us -uc cd build; dpkg-buildpackage -rfakeroot -b -us -uc
lintian ${DOC_DEB} lintian ${DOC_DEB}
@ -233,5 +235,5 @@ update: clean
make all make all
clean: clean:
rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build apidata.js apidoc.js rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidata.js api-viewer/apidoc.js

0
PVEAPI.js → api-viewer/PVEAPI.js
View File

0
apidoc.htm → api-viewer/index.html
View File

3
doc-debian/pve-docs.conf
View File

@ -5,6 +5,3 @@
</Directory> </Directory>
Alias /pve-docs /usr/share/pve-docs/ Alias /pve-docs /usr/share/pve-docs/
Alias /pve2-api-doc /usr/share/pve-docs/pve2-api-doc/

5
index.adoc
View File

@ -67,3 +67,8 @@ Configuration Options
|=========================================================== |===========================================================
API Viewer
~~~~~~~~~~
The link:api-viewer/index.html[API viewer] is a tiny web application
which allows you to inspect all available API calls.