# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS    =
SPHINXBUILD   = sphinx-build
PAPER         = a4
LATEXDIR      = latex
BUILDDIR      = _build
SRCDIR        = src
STATICDIR     = _static
DESTDIR       = ../../../share/doc/ajis

# Internal variables.
PAPEROPT_a4     = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

VERSION=7.2.1.`date +%Y%m%d`w

ifeq ($(gnat_edition),FSFEDITION)
  EDITION=GNAT Edition
  SUBTITLE=A Toolkit for GNAT, the GNU Ada Compiler
else
  ifeq ($(gnat_edition),GPLEDITION)
    EDITION=GNAT GPL Edition
    SUBTITLE=A Toolkit for GNAT, the GNU Ada Compiler
  else
    EDITION=GNAT Pro Edition
    SUBTITLE=A Toolkit for the GNAT Pro Ada Compiler
  endif
endif

ifneq ($(GNAT_VERSION),)
  VERSION=$(GNAT_VERSION)
endif

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest

help:
	@echo "Please use \`make <target>' where <target> is one of"
	@echo "  html       to make standalone HTML files"
	@echo "  dirhtml    to make HTML files named index.html in directories"
	@echo "  singlehtml to make a single large HTML file"
	@echo "  pickle     to make pickle files"
	@echo "  json       to make JSON files"
	@echo "  htmlhelp   to make HTML files and a HTML help project"
	@echo "  qthelp     to make HTML files and a qthelp project"
	@echo "  devhelp    to make HTML files and a Devhelp project"
	@echo "  epub       to make an epub"
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
	@echo "  text       to make text files"
	@echo "  man        to make manual pages"
	@echo "  changes    to make an overview of all changed/added/deprecated items"
	@echo "  linkcheck  to check all external links for integrity"
	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"

clean:
	-rm -rf $(SRCDIR)
	-rm -rf $(BUILDDIR)
	-rm -rf $(STATICDIR)
	-rm -rf html

html:
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

html_for_docs:
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
	@echo
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
	@echo
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
	@echo
	@echo "Build finished; now you can process the pickle files."

json:
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
	@echo
	@echo "Build finished; now you can process the JSON files."

htmlhelp:
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
	@echo
	@echo "Build finished; now you can run HTML Help Workshop with the" \
	      ".hhp project file in $(BUILDDIR)/htmlhelp."

qthelp:
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
	@echo
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/AJIS.qhcp"
	@echo "To view the help file:"
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/AJIS.qhc"

devhelp:
	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
	@echo
	@echo "Build finished."
	@echo "To view the help file:"
	@echo "# mkdir -p $$HOME/.local/share/devhelp/AJIS"
	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/AJIS"
	@echo "# devhelp"

epub:
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
	@echo
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex:
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/$(LATEXDIR)
	@echo
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/$(LATEXDIR)."
	@echo "Run \`make' in that directory to run these through (pdf)latex" \
	      "(use \`make latexpdf' here to do that automatically)."

latexpdf:
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/$(LATEXDIR)
	@echo "Running LaTeX files through pdflatex..."
	make -C $(BUILDDIR)/$(LATEXDIR) all-pdf
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/$(LATEXDIR)."

latexpdf_letter:
	-rm -rf $(BUILDDIR)/$(LATEXDIR)/*
	make PAPER=letter LATEXDIR=latex_letter latexpdf
	cp $(BUILDDIR)/latex_letter/ajis_ug.pdf $(DESTDIR)/pdf/ajis_ug-letter.pdf

latexpdf_a4:
	-rm -rf $(BUILDDIR)/$(LATEXDIR)/*
	make PAPER=a4 LATEXDIR=latex_a4 latexpdf
	cp $(BUILDDIR)/latex_a4/ajis_ug.pdf $(DESTDIR)/pdf/ajis_ug.pdf

info:
	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
	@echo "Running Texinfo files through makeinfo..."
	make -C $(BUILDDIR)/texinfo info
	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

info_and_text:
	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
	@echo "Running Texinfo files through makeinfo..."
	make -C $(BUILDDIR)/texinfo info
	make -C $(BUILDDIR)/texinfo ajis_ug.txt
	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
	cp $(BUILDDIR)/texinfo/*.info $(DESTDIR)/info/.
	cp $(BUILDDIR)/texinfo/*.txt $(DESTDIR)/txt/.

text:
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
	@echo
	@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
	@echo
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

changes:
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
	@echo
	@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
	@echo
	@echo "Link check complete; look for any errors in the above output " \
	      "or in $(BUILDDIR)/linkcheck/output.txt."

doctest:
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
	@echo "Testing of doctests in the sources finished, look at the " \
	      "results in $(BUILDDIR)/doctest/output.txt."

mkdirs:
	-mkdir $(SRCDIR)
	-mkdir $(BUILDDIR)
	-mkdir $(BUILDDIR)/html
	-mkdir $(BUILDDIR)/text
	-mkdir $(BUILDDIR)/latex
	-mkdir $(BUILDDIR)/latex_a4
	-mkdir $(BUILDDIR)/latex_letter
	-mkdir $(BUILDDIR)/texinfo
	-mkdir $(STATICDIR)
	-mkdir -p $(DESTDIR)
	-mkdir -p $(DESTDIR)/pdf
	-mkdir -p $(DESTDIR)/txt
	-mkdir -p $(DESTDIR)/info

chapters: mkdirs
	-mkdir $(SRCDIR)/images

init_for_docs:
	-cp conf.py.svn conf.py
	-cp index.rst.svn ajis_ug.rst
	sed -i -e "s/^:Date:/:Date: `date +%Y-%m-%d`/" \
	       ajis_ug.rst
	sed -i -e "s/^:Copyright:/:Copyright: C 1995-`date +%Y`, Free Software Foundation/" \
	       ajis_ug.rst
	sed -i -e "s/^:Version:/:Version: $(VERSION)/" \
	       ajis_ug.rst
	sed -i -e "s/^:Edition:/:Edition: $(EDITION)/" \
	       ajis_ug.rst
	sed -i -e "s/^:Subtitle:/:Subtile: $(SUBTITLE)/" \
	       ajis_ug.rst
	sed -i -e "s/getting_started_max_depth/3/g" \
	       ajis_ug.rst
	sed -i -e "s/html_theme = \"basic\"/html_theme = \"sphinxdoc\"/g" \
	       -e "s/html_theme_options/html_theme_options_removed/g" \
	       conf.py

chapters_for_docs: chapters

html_files: init_for_docs chapters_for_docs html_for_docs
	cp -r $(BUILDDIR)/html $(DESTDIR)

pdf_files: init_for_docs chapters_for_docs latexpdf_letter latexpdf_a4

clean_up:
	rm -rf $(BUILDDIR)
	rm -rf $(STATICDIR)
	rm -rf $(SRCDIR)
	
all: clean_up html_files pdf_files info_and_text
	rm -rf $(BUILDDIR)
	rm -rf $(STATICDIR)
	rm -rf $(SRCDIR)
	rm ajis_ug.rst
	rm conf.py
