Skip to content
GitLab
Select Git revision
  • 298-new-passwordmethod-argon2-is-now-available-if-fd-is-used-with-openldap-2-5
  • 300-extractor-update-documention-as-the-logic-as-changed
  • dev default
  • 1.5
  • 287-the-dyngroup-plugin-should-be-dyngroups-in-the-documentation
  • master
  • 1.4
  • 1.3
  • fusiondirectory-1.5
  • fusiondirectory-1.3.1
  • fusiondirectory-1.4
Find file BlameHistoryPermalink
Makefile 7.51 KiB
1 
# Makefile for Sphinx documentation
2 
#
3
4 
# You can set these variables from the command line.
5 
SPHINXOPTS    =
6 
SPHINXBUILD   = sphinx-build
7 
PAPER         =
8 
BUILDDIR      = build
9
10 
# Internal variables.
11 
PAPEROPT_a4     = -D latex_paper_size=a4
12 
PAPEROPT_letter = -D latex_paper_size=letter
13 
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14 
# the i18n builder cannot share the environment and doctrees with the others
15 
I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
16
17 
.PHONY: help
18 
help:
19 
	@echo "Please use \`make <target>' where <target> is one of"
20 
	@echo "  html       to make standalone HTML files"
21 
	@echo "  dirhtml    to make HTML files named index.html in directories"
22 
	@echo "  singlehtml to make a single large HTML file"
23 
	@echo "  pickle     to make pickle files"
24 
	@echo "  json       to make JSON files"
25 
	@echo "  htmlhelp   to make HTML files and a HTML help project"
26 
	@echo "  qthelp     to make HTML files and a qthelp project"
27 
	@echo "  applehelp  to make an Apple Help Book"
28 
	@echo "  devhelp    to make HTML files and a Devhelp project"
29 
	@echo "  epub       to make an epub"
30 
	@echo "  epub3      to make an epub3"
31 
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
32 
	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
33 
	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
34 
	@echo "  text       to make text files"
35 
	@echo "  man        to make manual pages"
36 
	@echo "  texinfo    to make Texinfo files"
37 
	@echo "  info       to make Texinfo files and run them through makeinfo"
38 
	@echo "  gettext    to make PO message catalogs"
39 
	@echo "  changes    to make an overview of all changed/added/deprecated items"
40 
	@echo "  xml        to make Docutils-native XML files"
41 
	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
42 
	@echo "  linkcheck  to check all external links for integrity"
43 
	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
44 
	@echo "  coverage   to run coverage check of the documentation (if enabled)"
45 
	@echo "  dummy      to check syntax errors of document sources"
46
47 
.PHONY: clean
48 
clean:
49 
	rm -rf $(BUILDDIR)/*
50
51 
.PHONY: html
52 
html:
53 
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54 
	@echo
55 
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56
57 
.PHONY: dirhtml
58 
dirhtml:
59 
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
60 
	@echo
61 
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
62
63 
.PHONY: singlehtml
64 
singlehtml:
65 
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66 
	@echo
67 
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68
69 
.PHONY: pickle
70 
pickle:
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." .PHONY: json json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." .PHONY: htmlhelp 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." .PHONY: qthelp 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/FusionDirectoryUserManual.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FusionDirectoryUserManual.qhc" .PHONY: applehelp applehelp: $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp @echo @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." @echo "N.B. You won't be able to view it unless you put it in" \ "~/Library/Documentation/Help or install it in your application" \ "bundle." .PHONY: devhelp devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/FusionDirectoryUserManual" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FusionDirectoryUserManual" @echo "# devhelp" .PHONY: epub epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." .PHONY: epub3 epub3: $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 @echo @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." .PHONY: latex latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." .PHONY: latexpdf latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..."
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
$(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." .PHONY: latexpdfja latexpdfja: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." .PHONY: text text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." .PHONY: man man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." .PHONY: texinfo texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." .PHONY: info 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." .PHONY: gettext gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." .PHONY: changes changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." .PHONY: linkcheck 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." .PHONY: doctest doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." .PHONY: coverage coverage: $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage @echo "Testing of coverage in the sources finished, look at the " \ "results in $(BUILDDIR)/coverage/python.txt." .PHONY: xml xml:
211212213214215216217218219220221222223224225226
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml @echo @echo "Build finished. The XML files are in $(BUILDDIR)/xml." .PHONY: pseudoxml pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." .PHONY: dummy dummy: $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy @echo @echo "Build finished. Dummy builder generates no files."