1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

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'
This commit is contained in:
Adrian Likins 2017-01-13 14:32:27 -05:00 committed by GitHub
parent 8928adf62e
commit 0381bc170c
3 changed files with 32 additions and 8 deletions

View file

@ -1,12 +1,11 @@
SITELIB = $(shell python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")
FORMATTER=../../hacking/module_formatter.py
DUMPER=../../hacking/dump_playbook_attributes.py
CPUS ?= 1
CPUS := $(shell nproc)
all: clean docs
docs: clean directives modules staticmin
./build-site.py -j $(CPUS)
docs: clean directives modules htmldocs
-(cp *.ico htmlout/)
-(cp *.jpg htmlout/)
-(cp *.png htmlout/)
@ -15,16 +14,14 @@ variables:
(mkdir -p htmlout/)
dot variables.dot -Tpng -o htmlout/variables.png
viewdocs: clean staticmin
./build-site.py -j $(CPUS) view
htmldocs: staticmin
./build-site.py -j $(CPUS) rst
htmldocs: directives modules staticmin
CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx html
webdocs: htmldocs
clean:
-rm -rf htmlout
-rm -rf _build
-rm -f .buildinfo
-rm -f *.inv
-rm -rf *.doctrees

View file

@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS = -j $(CPUS)
SPHINXBUILD = sphinx-build
SPHINXPROJ = sdfsdf
SOURCEDIR = .
BUILDDIR = _build
# 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)

7
docs/docsite/build.sh Executable file
View file

@ -0,0 +1,7 @@
#!/bin/bash
make -f Makefile.old clean
make -f Makefile.old modules
make -f Makefile.old directives
time make html