ansible/docs/docsite/Makefile.sphinx

# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS    = -j $(CPUS) -n -w rst_warnings
SPHINXBUILD   = sphinx-build
SPHINXPROJ    = sdfsdf
SOURCEDIR     = rst

# Sets the build output directory if it's not specified on the command line
ifndef BUILDDIR
   BUILDDIR      = _build
endif

# Put it first so that "make" without argument is like "make help".
help:
	$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile.sphinx

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile.sphinx
	$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Docsite sphinx rm buildsite (and speed up docs build) (#20237) Replace docs build-site.py with default-ish sphinx build This seems to speed up docsite build _alot_. The Makefile.sphinx is the sphinx-quickstart generated makefile with a few changes. The CPUS env var or 'nproc' output is used for the number of cpus passed to 'sphinx-build -j' 2017-01-13 19:32:27 +00:00			`# Minimal makefile for Sphinx documentation`
			`#`

			`# You can set these variables from the command line.`
Generate plugin rst (#28901) Generate rst docs for plugins Based on rst generated for modules. But generated plugin docs go into docs/docsite/rst/plugins/$PLUGIN_TYPE/plugin_name.rst ( docs/docsite/rst/plugins/connection/ssh.py for ex) * move plugins docs to rst/_plugins/ subdirs for namespace Only gen support pages for modules for now. * Add generated plugin docs to gitignore* add list__plugins templates support MODULES/PLUGINS filters for make htmldocs Add a 'PLUGINS=ssh' filter env var like MODULES to filter plugins to build docs for. * fixup 'historical' version_added, skip plugins/loader.py * Fix plugins_by_support ref link to new plugins// location use :ref: for common_return_values, allow empty version_added * warnings on missing doc info * add a prefix to _random_choice It was colliding with the target for random_choice plugin 2017-09-19 15:14:27 +00:00			`SPHINXOPTS = -j $(CPUS) -n -w rst_warnings`
Docsite sphinx rm buildsite (and speed up docs build) (#20237) Replace docs build-site.py with default-ish sphinx build This seems to speed up docsite build _alot_. The Makefile.sphinx is the sphinx-quickstart generated makefile with a few changes. The CPUS env var or 'nproc' output is used for the number of cpus passed to 'sphinx-build -j' 2017-01-13 19:32:27 +00:00			`SPHINXBUILD = sphinx-build`
			`SPHINXPROJ = sdfsdf`
Use correct path for docsite src (rst/) 2017-01-13 22:20:40 +00:00			`SOURCEDIR = rst`
Adds the ability to override the doc build output directory from the command line. (#36604) * Adds the ability to override the doc build output from the command line. * For safety, removed straight rm of BUILDDIR and removed subdirectories instead. * Added check to see if BUILDDIR was defined to main makefile 2018-03-01 00:01:18 +00:00
			`# Sets the build output directory if it's not specified on the command line`
			`ifndef BUILDDIR`
			`BUILDDIR = _build`
			`endif`
Docsite sphinx rm buildsite (and speed up docs build) (#20237) Replace docs build-site.py with default-ish sphinx build This seems to speed up docsite build _alot_. The Makefile.sphinx is the sphinx-quickstart generated makefile with a few changes. The CPUS env var or 'nproc' output is used for the number of cpus passed to 'sphinx-build -j' 2017-01-13 19:32:27 +00:00
			`# Put it first so that "make" without argument is like "make help".`
			`help:`
Use correct path for docsite src (rst/) 2017-01-13 22:20:40 +00:00			`$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)`
Docsite sphinx rm buildsite (and speed up docs build) (#20237) Replace docs build-site.py with default-ish sphinx build This seems to speed up docsite build _alot_. The Makefile.sphinx is the sphinx-quickstart generated makefile with a few changes. The CPUS env var or 'nproc' output is used for the number of cpus passed to 'sphinx-build -j' 2017-01-13 19:32:27 +00:00
			`.PHONY: help Makefile.sphinx`

			`# Catch-all target: route all unknown targets to Sphinx using the new`
			`# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).`
			`%: Makefile.sphinx`
Generate plugin rst (#28901) Generate rst docs for plugins Based on rst generated for modules. But generated plugin docs go into docs/docsite/rst/plugins/$PLUGIN_TYPE/plugin_name.rst ( docs/docsite/rst/plugins/connection/ssh.py for ex) * move plugins docs to rst/_plugins/ subdirs for namespace Only gen support pages for modules for now. * Add generated plugin docs to gitignore* add list__plugins templates support MODULES/PLUGINS filters for make htmldocs Add a 'PLUGINS=ssh' filter env var like MODULES to filter plugins to build docs for. * fixup 'historical' version_added, skip plugins/loader.py * Fix plugins_by_support ref link to new plugins// location use :ref: for common_return_values, allow empty version_added * warnings on missing doc info * add a prefix to _random_choice It was colliding with the target for random_choice plugin 2017-09-19 15:14:27 +00:00			`$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)`