2017-01-20 05:11:53 +01:00
|
|
|
OS := $(shell uname -s)
|
2017-01-18 03:55:03 +01:00
|
|
|
SITELIB = $(shell python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()"):
|
2017-03-23 06:13:23 +01:00
|
|
|
FORMATTER=../bin/plugin_formatter.py
|
2017-07-14 15:24:45 +02:00
|
|
|
TESTING_FORMATTER=../bin/testing_formatter.sh
|
2017-03-23 06:13:23 +01:00
|
|
|
DUMPER=../bin/dump_keywords.py
|
2017-08-31 16:11:05 +02:00
|
|
|
CONFIG_DUMPER=../bin/dump_config.py
|
2017-09-07 21:44:20 +02:00
|
|
|
GENERATE_CLI=../bin/generate_man.py
|
2017-01-20 04:50:29 +01:00
|
|
|
ifeq ($(shell echo $(OS) | egrep -ic 'Darwin|FreeBSD|OpenBSD|DragonFly'),1)
|
2017-01-20 05:09:55 +01:00
|
|
|
CPUS ?= $(shell sysctl hw.ncpu|awk '{print $$2}')
|
2017-01-13 20:38:02 +01:00
|
|
|
else
|
2017-01-20 05:09:55 +01:00
|
|
|
CPUS ?= $(shell nproc)
|
2017-01-13 20:38:02 +01:00
|
|
|
endif
|
2012-10-08 13:44:38 +02:00
|
|
|
|
2018-03-01 01:01:18 +01:00
|
|
|
# Sets the build output directory if it's not already specified
|
|
|
|
ifndef BUILDDIR
|
|
|
|
BUILDDIR = _build
|
|
|
|
endif
|
|
|
|
|
2017-09-19 17:14:27 +02:00
|
|
|
MODULE_ARGS=
|
|
|
|
ifdef MODULES
|
|
|
|
MODULE_ARGS = -l $(MODULES)
|
|
|
|
endif
|
|
|
|
|
|
|
|
PLUGIN_ARGS=
|
|
|
|
ifdef PLUGINS
|
|
|
|
PLUGIN_ARGS = -l $(PLUGINS)
|
|
|
|
endif
|
|
|
|
|
2018-04-16 15:29:49 +02:00
|
|
|
DOC_PLUGINS ?= cache callback connection inventory lookup shell strategy vars
|
2017-09-23 05:19:50 +02:00
|
|
|
|
2017-06-02 20:11:28 +02:00
|
|
|
assertrst:
|
|
|
|
ifndef rst
|
|
|
|
$(error specify document or pattern with rst=somefile.rst)
|
|
|
|
endif
|
|
|
|
|
2017-01-18 03:55:03 +01:00
|
|
|
all: docs
|
2012-10-08 13:44:38 +02:00
|
|
|
|
2018-09-12 22:50:36 +02:00
|
|
|
docs: htmldocs
|
2014-05-09 23:13:01 +02:00
|
|
|
|
2017-10-11 06:15:25 +02:00
|
|
|
generate_rst: staticmin config cli keywords modules plugins testing
|
2017-09-07 21:44:20 +02:00
|
|
|
|
2017-09-13 22:45:05 +02:00
|
|
|
htmldocs: generate_rst
|
2017-01-13 20:32:27 +01:00
|
|
|
CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx html
|
2012-10-08 13:44:38 +02:00
|
|
|
|
2017-09-13 22:45:05 +02:00
|
|
|
singlehtmldocs: generate_rst
|
|
|
|
CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx singlehtml
|
|
|
|
|
2017-01-18 03:55:03 +01:00
|
|
|
webdocs: docs
|
2016-01-25 16:33:50 +01:00
|
|
|
|
2017-01-18 03:55:03 +01:00
|
|
|
#TODO: leaving htmlout removal for those having older versions, should eventually be removed also
|
2012-10-08 13:44:38 +02:00
|
|
|
clean:
|
2018-03-01 01:01:18 +01:00
|
|
|
@echo "Cleaning $(BUILDDIR)"
|
|
|
|
-rm -rf $(BUILDDIR)/doctrees
|
|
|
|
-rm -rf $(BUILDDIR)/html
|
2013-06-09 19:55:58 +02:00
|
|
|
-rm -rf htmlout
|
2017-12-21 10:47:39 +01:00
|
|
|
-rm -rf module_docs
|
2017-01-13 20:32:27 +01:00
|
|
|
-rm -rf _build
|
2012-10-08 13:44:38 +02:00
|
|
|
-rm -f .buildinfo
|
2017-04-10 20:01:10 +02:00
|
|
|
-rm -f objects.inv
|
2012-10-08 13:44:38 +02:00
|
|
|
-rm -rf *.doctrees
|
2014-01-03 02:35:29 +01:00
|
|
|
@echo "Cleaning up minified css files"
|
|
|
|
find . -type f -name "*.min.css" -delete
|
2012-10-08 13:44:38 +02:00
|
|
|
@echo "Cleaning up byte compiled python stuff"
|
|
|
|
find . -regex ".*\.py[co]$$" -delete
|
|
|
|
@echo "Cleaning up editor backup files"
|
|
|
|
find . -type f \( -name "*~" -or -name "#*" \) -delete
|
|
|
|
find . -type f \( -name "*.swp" \) -delete
|
2014-01-28 17:04:34 +01:00
|
|
|
@echo "Cleaning up generated rst"
|
2018-02-13 19:52:13 +01:00
|
|
|
-rm rst/cli/ansible-*.rst
|
|
|
|
-rm rst/cli/ansible.rst
|
|
|
|
-rm rst/modules/*_by_category.rst
|
|
|
|
-rm rst/modules/list_of_*.rst
|
|
|
|
-rm rst/modules/*_maintained.rst
|
|
|
|
-rm rst/modules/*_module.rst
|
|
|
|
-rm rst/modules/*_plugin.rst
|
2017-01-18 20:34:01 +01:00
|
|
|
-rm rst/playbooks_directives.rst
|
2017-09-23 05:19:50 +02:00
|
|
|
-rm rst/plugins/*/*.rst
|
2018-02-13 19:52:13 +01:00
|
|
|
-rm rst/reference_appendices/config.rst
|
|
|
|
-rm rst/reference_appendices/playbooks_keywords.rst
|
2012-10-08 13:44:38 +02:00
|
|
|
|
2018-02-13 19:52:13 +01:00
|
|
|
.PHONY: docs clean
|
2012-10-08 13:44:38 +02:00
|
|
|
|
2017-09-07 21:44:20 +02:00
|
|
|
# TODO: make generate_man output dir cli option
|
|
|
|
cli: $(GENERATE_CLI)
|
2018-02-13 23:43:26 +01:00
|
|
|
mkdir -p rst/cli
|
2018-02-13 16:23:55 +01:00
|
|
|
PYTHONPATH=../../lib $(GENERATE_CLI) --template-file=../templates/cli_rst.j2 --output-dir=rst/cli/ --output-format rst ../../lib/ansible/cli/*.py
|
2017-09-07 21:44:20 +02:00
|
|
|
|
2017-03-23 06:13:23 +01:00
|
|
|
keywords: $(FORMATTER) ../templates/playbooks_keywords.rst.j2
|
2018-02-13 16:23:55 +01:00
|
|
|
PYTHONPATH=../../lib $(DUMPER) --template-dir=../templates --output-dir=rst/reference_appendices/ -d ./keyword_desc.yml
|
2016-02-25 22:41:50 +01:00
|
|
|
|
2017-08-31 16:11:05 +02:00
|
|
|
config:
|
2018-02-13 16:23:55 +01:00
|
|
|
PYTHONPATH=../../lib $(CONFIG_DUMPER) --template-file=../templates/config.rst.j2 --output-dir=rst/reference_appendices/ -d ../../lib/ansible/config/base.yml
|
2017-08-31 16:11:05 +02:00
|
|
|
|
2017-03-23 06:13:23 +01:00
|
|
|
modules: $(FORMATTER) ../templates/plugin.rst.j2
|
2018-02-13 16:23:55 +01:00
|
|
|
PYTHONPATH=../../lib $(FORMATTER) -t rst --template-dir=../templates --module-dir=../../lib/ansible/modules -o rst/modules/ $(MODULE_ARGS)
|
2017-09-19 17:14:27 +02:00
|
|
|
|
|
|
|
plugins: $(FORMATTER) ../templates/plugin.rst.j2
|
2017-09-23 05:19:50 +02:00
|
|
|
@echo "looping over doc plugins"
|
|
|
|
for plugin in $(DOC_PLUGINS); \
|
|
|
|
do \
|
2018-02-13 16:23:55 +01:00
|
|
|
PYTHONPATH=../../lib $(FORMATTER) -t rst --plugin-type $$plugin --template-dir=../templates --module-dir=../../lib/ansible/plugins/$$plugin -o rst $(PLUGIN_ARGS); \
|
2017-09-23 05:19:50 +02:00
|
|
|
done
|
2012-10-08 13:44:38 +02:00
|
|
|
|
2017-07-14 15:24:45 +02:00
|
|
|
testing:
|
|
|
|
$(TESTING_FORMATTER)
|
|
|
|
|
2014-01-03 02:35:29 +01:00
|
|
|
staticmin:
|
2016-01-05 01:52:37 +01:00
|
|
|
cat _themes/srtd/static/css/theme.css | sed -e 's/^[ ]*//g; s/[ ]*$$//g; s/\([:{;,]\) /\1/g; s/ {/{/g; s/\/\*.*\*\///g; /^$$/d' | sed -e :a -e '$$!N; s/\n\(.\)/\1/; ta' > _themes/srtd/static/css/theme.min.css
|
2017-05-01 19:40:49 +02:00
|
|
|
|
|
|
|
epub:
|
2018-05-25 05:30:14 +02:00
|
|
|
(CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx epub)
|
2017-06-02 20:11:28 +02:00
|
|
|
|
|
|
|
htmlsingle: assertrst
|
2018-03-01 01:01:18 +01:00
|
|
|
sphinx-build -j $(CPUS) -b html -d $(BUILDDIR)/doctrees ./rst $(BUILDDIR)/html rst/$(rst)
|
2018-04-05 19:46:46 +02:00
|
|
|
@echo "Output is in $(BUILDDIR)/html/$(rst:.rst=.html)"
|