mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-26 22:51:23 -07: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:
parent
8928adf62e
commit
0381bc170c
3 changed files with 32 additions and 8 deletions
|
@ -1,12 +1,11 @@
|
||||||
SITELIB = $(shell python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")
|
SITELIB = $(shell python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")
|
||||||
FORMATTER=../../hacking/module_formatter.py
|
FORMATTER=../../hacking/module_formatter.py
|
||||||
DUMPER=../../hacking/dump_playbook_attributes.py
|
DUMPER=../../hacking/dump_playbook_attributes.py
|
||||||
CPUS ?= 1
|
CPUS := $(shell nproc)
|
||||||
|
|
||||||
all: clean docs
|
all: clean docs
|
||||||
|
|
||||||
docs: clean directives modules staticmin
|
docs: clean directives modules htmldocs
|
||||||
./build-site.py -j $(CPUS)
|
|
||||||
-(cp *.ico htmlout/)
|
-(cp *.ico htmlout/)
|
||||||
-(cp *.jpg htmlout/)
|
-(cp *.jpg htmlout/)
|
||||||
-(cp *.png htmlout/)
|
-(cp *.png htmlout/)
|
||||||
|
@ -15,16 +14,14 @@ variables:
|
||||||
(mkdir -p htmlout/)
|
(mkdir -p htmlout/)
|
||||||
dot variables.dot -Tpng -o htmlout/variables.png
|
dot variables.dot -Tpng -o htmlout/variables.png
|
||||||
|
|
||||||
viewdocs: clean staticmin
|
htmldocs: directives modules staticmin
|
||||||
./build-site.py -j $(CPUS) view
|
CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx html
|
||||||
|
|
||||||
htmldocs: staticmin
|
|
||||||
./build-site.py -j $(CPUS) rst
|
|
||||||
|
|
||||||
webdocs: htmldocs
|
webdocs: htmldocs
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
-rm -rf htmlout
|
-rm -rf htmlout
|
||||||
|
-rm -rf _build
|
||||||
-rm -f .buildinfo
|
-rm -f .buildinfo
|
||||||
-rm -f *.inv
|
-rm -f *.inv
|
||||||
-rm -rf *.doctrees
|
-rm -rf *.doctrees
|
||||||
|
|
20
docs/docsite/Makefile.sphinx
Normal file
20
docs/docsite/Makefile.sphinx
Normal 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
7
docs/docsite/build.sh
Executable 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
|
Loading…
Add table
Add a link
Reference in a new issue