diff options
| author | Sandra McCann <samccann@redhat.com> | 2021-02-17 10:57:05 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-17 09:57:05 -0600 |
| commit | ccbfdec334a7b0443f2daecf9f96ac5c5a33fd45 (patch) | |
| tree | c930b141173f7360924f341a37091a2420526dcb /Makefile | |
| parent | 27baa8cd8697d078ab44e9ad19def2dfc738cf8a (diff) | |
| download | ansible-ccbfdec334a7b0443f2daecf9f96ac5c5a33fd45.tar.gz | |
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>
Diffstat (limited to 'Makefile')
| -rw-r--r-- | Makefile | 5 |
1 files changed, 5 insertions, 0 deletions
@@ -5,6 +5,7 @@ # useful targets: # make clean ---------------- clean up # make webdocs -------------- produce ansible doc at docs/docsite/_build/html +# make coredocs ------------- produce core doc at docs/docsite/_build/html # make sdist ---------------- produce a tarball # make deb-src -------------- produce a DEB source # make deb ------------------ produce a DEB @@ -270,6 +271,10 @@ epub: webdocs: (cd docs/docsite/; CPUS=$(CPUS) $(MAKE) docs) +.PHONY: coredocs +coredocs: + (cd docs/docsite/; CPUS=$(CPUS) $(MAKE) coredocs) + .PHONY: linkcheckdocs linkcheckdocs: (cd docs/docsite/; CPUS=$(CPUS) $(MAKE) linkcheckdocs) |