mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Update the Makefile and build-site.py to notify of missing dependencies for doc compiling
This commit is contained in:
parent
e2c1b34dbb
commit
badb41390e
2 changed files with 12 additions and 3 deletions
7
Makefile
7
Makefile
|
@ -20,9 +20,13 @@ OS = $(shell uname -s)
|
||||||
# Manpages are currently built with asciidoc -- would like to move to markdown
|
# Manpages are currently built with asciidoc -- would like to move to markdown
|
||||||
# This doesn't evaluate until it's called. The -D argument is the
|
# This doesn't evaluate until it's called. The -D argument is the
|
||||||
# directory of the target file ($@), kinda like `dirname`.
|
# directory of the target file ($@), kinda like `dirname`.
|
||||||
|
MANPAGES := docs/man/man1/ansible.1 docs/man/man1/ansible-playbook.1 docs/man/man1/ansible-pull.1 docs/man/man1/ansible-doc.1
|
||||||
|
ifneq ($(shell which a2x 2>/dev/null),)
|
||||||
ASCII2MAN = a2x -D $(dir $@) -d manpage -f manpage $<
|
ASCII2MAN = a2x -D $(dir $@) -d manpage -f manpage $<
|
||||||
ASCII2HTMLMAN = a2x -D docs/html/man/ -d manpage -f xhtml
|
ASCII2HTMLMAN = a2x -D docs/html/man/ -d manpage -f xhtml
|
||||||
MANPAGES := docs/man/man1/ansible.1 docs/man/man1/ansible-playbook.1 docs/man/man1/ansible-pull.1 docs/man/man1/ansible-doc.1
|
else
|
||||||
|
ASCII2MAN = @echo "ERROR: AsciiDoc 'a2x' command is not installed but is required to build $(MANPAGES)" && exit 1
|
||||||
|
endif
|
||||||
|
|
||||||
SITELIB = $(shell python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")
|
SITELIB = $(shell python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")
|
||||||
|
|
||||||
|
@ -186,4 +190,3 @@ webdocs:
|
||||||
# just for quick testing of all the module docs
|
# just for quick testing of all the module docs
|
||||||
webdocs2:
|
webdocs2:
|
||||||
(cd docsite; make modules)
|
(cd docsite; make modules)
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,13 @@ __docformat__ = 'restructuredtext'
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
import traceback
|
import traceback
|
||||||
from sphinx.application import Sphinx
|
try:
|
||||||
|
from sphinx.application import Sphinx
|
||||||
|
except ImportError:
|
||||||
|
print "#################################"
|
||||||
|
print "Dependency missing: Python Sphinx"
|
||||||
|
print "#################################"
|
||||||
|
sys.exit(1)
|
||||||
import os
|
import os
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue