mirror of
https://github.com/AdaCore/gpr.git
synced 2026-02-12 12:58:39 -08:00
df72f40d2d
We do all the work inside Sphinx, instead of requiring a change in the Makefile: we generate html titles ids through Sphinx we call pagefind though sphinx instead As a bonus, we introduce a small extension dedicated to pagefind. Comes from the work of Boris Yakobowski <yakobowski@adacore.com>
74 lines
1.9 KiB
Makefile
74 lines
1.9 KiB
Makefile
# Makefile for Sphinx documentation
|
|
|
|
# You can set these variables from the command line.
|
|
SPHINXOPTS =
|
|
SPHINXBUILD = sphinx-build
|
|
PAPER =
|
|
BUILDDIR = .
|
|
SOURCEDIR = .
|
|
|
|
# Internal variables.
|
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
PAPEROPT_letter = -D latex_paper_size=letter
|
|
ALLSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) \
|
|
-c $(SOURCEDIR)/share \
|
|
-d $(BUILDDIR)/$*/doctrees \
|
|
$(SOURCEDIR)
|
|
FMT_LIST=html txt info pdf
|
|
DOC_NAME=gprbuild_ug
|
|
CP=cp
|
|
|
|
WORK_DIR=__python__
|
|
GPRDOC_FILE=
|
|
OUT_FILE=gprbuild_ug/attributes.rst
|
|
|
|
-include ../makefile.setup
|
|
|
|
.PHONY: help clean
|
|
|
|
all: $(foreach fmt, $(FMT_LIST), $(fmt))
|
|
|
|
help:
|
|
@echo "Please use \`make <target>' where <target> is one of"
|
|
@echo " html to make standalone HTML files"
|
|
@echo " pdf to make LaTeX files and run them through pdflatex"
|
|
@echo " txt to make text files"
|
|
@echo " texinfo to make Texinfo files"
|
|
@echo " info to make info files"
|
|
@echo " all to build documentation in all formats"
|
|
@echo ""
|
|
@echo "source and location can be overriden using SOURCEDIR and BUILDDIR variables"
|
|
|
|
clean:
|
|
-rm -rf $(BUILDDIR)/html \
|
|
$(BUILDDIR)/pdf \
|
|
$(BUILDDIR)/txt \
|
|
$(BUILDDIR)/info \
|
|
$(BUILDDIR)/doctrees \
|
|
${WORK_DIR}/metadata/__pycache__ \
|
|
${GPRDOC_FILE} \
|
|
share/__pycache__
|
|
|
|
html: force
|
|
PAGEFIND_SITE=$(BUILDDIR)/html $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
|
|
|
pdf: force
|
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
|
|
$(MAKE) -C $(BUILDDIR)/pdf all-pdf LATEXOPTS="-interaction=nonstopmode"
|
|
|
|
txt: force
|
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/$*/txt
|
|
$(MAKE) -C $(BUILDDIR)/txt plaintext
|
|
|
|
info: force
|
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/$*/info
|
|
$(MAKE) -C $(BUILDDIR)/info info
|
|
|
|
texinfo:
|
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/$*/texinfo
|
|
|
|
gen:
|
|
python3 ${WORK_DIR}/generate_gpr2_documentation.py --input=${GPRDOC_FILE} --output=${OUT_FILE}
|
|
|
|
force:
|