# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = build PYTHON = python3 # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source CONFIG_OPTION_TABLES = source/configuration/alotrc_table source/configuration/accounts_table COMMAND_OPTION_TABLES = source/usage/modes/bufferlist.rst \ source/usage/modes/envelope.rst \ source/usage/modes/global.rst \ source/usage/modes/search.rst \ source/usage/modes/taglist.rst \ source/usage/modes/thread.rst .PHONY: html help clean dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest help: @echo "Please use \`make ' where 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)" $(COMMAND_OPTION_TABLES): ../alot/commands/__init__.py $(PYTHON) source/generate_commands.py $(CONFIG_OPTION_TABLES): ../alot/defaults/alot.rc.spec $(PYTHON) source/generate_configs.py clean: -$(RM) -rf $(BUILDDIR)/* cleanall: clean -$(RM) -rf $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) html: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(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." devhelp: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/alot" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/alot" @echo "# devhelp" epub: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(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)." latexpdf: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." make -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." changes: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(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: $(CONFIG_OPTION_TABLES) $(COMMAND_OPTION_TABLES) $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt."