cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
ansible/docs/docsite/Makefile.sphinx

27 lines
822 B
Text
Raw Normal View History

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 20:32:27 +01:00
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
Split Ansible docs from core docs (#73616) * excludes scenario guides from core docs, splits porting guides and roadmaps, symlinks indices to create index.html pages, and adds .gitignore entries for conf.py and the toplevel index.rst files generated by the docs build This solution builds three types of docs: * ansible-2.10 and earlier: all the docs. Handle this via `make webdocs ANSIBLE_VERSION=2.10` * ansible-3 and later: a subset of the docs for the ansible package. Handle this via `make webdocs ANSIBLE_VERSION=3` (change the ANSIBLE_VERSION to match the version being built for. * ansible-core: a subset of the docs for the ansible-core package. Handle this via `make coredocs`. * `make webdocs` now always builds all the collection docs * Use `make coredocs` to limit it to core plugins only * The user specifies the desired version. If no ANSIBLE_VERSION is specified, build plugins for the latest release of ansible Co-authored-by: Toshio Kuratomi <a.badger@gmail.com> Co-authored-by: Matt Clay <matt@mystile.com>
2021-02-17 16:57:05 +01:00
SPHINXCONFDIR = rst
Documentation: Lay the ground for i18n work. (#73746) * Documentation: Lay the ground for i18n work. * Translating both ansible-core and ansible docs requires msgcat (a program from the gettext package). If msgcat is not present, only the ansible-core index file's strings will be extracted for translation. If this is a problem, a short hacking script could be written to take the place of msgcat (merging the various index pot files into a single pot file). Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2021-03-05 18:31:56 +01:00
LANGOPTS ?=
SPHINXOPTS ?= -j $(CPUS) -n -w rst_warnings -c "$(SPHINXCONFDIR)" $(LANGOPTS)
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 20:32:27 +01:00
SPHINXBUILD = sphinx-build
SPHINXPROJ = sdfsdf
Use correct path for docsite src (rst/)
2017-01-13 23:20:40 +01: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 01:01:18 +01: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 20:32:27 +01:00
# Put it first so that "make" without argument is like "make help".
help:
Use correct path for docsite src (rst/)
2017-01-13 23:20:40 +01: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 20:32:27 +01: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 17:14:27 +02:00
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Reference in a new issue Copy permalink