Generate a rst for config and env options from base.yml (#28739)

* wip, gen docs from config/base.yml

* wip

* dont change conf.py here

* cleanup, add dump_config --template-file cli opt

* some desc are string, some are lists...

TODO: fix base.yml so it is consistent

* Filter out TODO and empty descriptions
This commit is contained in:
Adrian Likins 2017-08-31 10:11:05 -04:00 committed by Sam Doran
parent 74daf2381b
commit 8035e68d44
4 changed files with 147 additions and 1 deletions

View file

@ -3,6 +3,7 @@ SITELIB = $(shell python -c "from distutils.sysconfig import get_python_lib; pri
FORMATTER=../bin/plugin_formatter.py
TESTING_FORMATTER=../bin/testing_formatter.sh
DUMPER=../bin/dump_keywords.py
CONFIG_DUMPER=../bin/dump_config.py
ifeq ($(shell echo $(OS) | egrep -ic 'Darwin|FreeBSD|OpenBSD|DragonFly'),1)
CPUS ?= $(shell sysctl hw.ncpu|awk '{print $$2}')
else
@ -18,7 +19,7 @@ all: docs
docs: clean htmldocs
htmldocs: testing keywords modules staticmin
htmldocs: testing keywords modules staticmin config
CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx html
webdocs: docs
@ -50,6 +51,9 @@ clean:
keywords: $(FORMATTER) ../templates/playbooks_keywords.rst.j2
PYTHONPATH=../../lib $(DUMPER) --template-dir=../templates --output-dir=rst/ -d ./keyword_desc.yml
config:
PYTHONPATH=../../lib $(CONFIG_DUMPER) --template-file=../templates/config.rst.j2 --output-dir=rst/ -d ../../lib/ansible/config/base.yml
modules: $(FORMATTER) ../templates/plugin.rst.j2
# Limit building of module documentation if requested.
ifdef MODULES

View file

@ -38,6 +38,7 @@ Ansible, Inc. releases a new major release of Ansible approximately every two mo
galaxy
test_strategies
faq
config
glossary
YAMLSyntax
porting_guides