ansys / pyansys-dev-guide

PyAnsys Project Developer's Guide

Home Page:http://dev.docs.pyansys.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Variable issue in PDF section for Makefile

klmcadams opened this issue · comments

Description of the modifications

Currently:

pdf:
        @$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
        cd $(BUILDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
        (test -f $(BUILDIR)/latex/*.pdf && echo pdf exists) || exit 1

New suggestion - change BUILDIR in lines 2 and 3 to BUILDDIR

pdf:
        @$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
        cd $(BUILDDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
        (test -f $(BUILDDIR)/latex/*.pdf && echo pdf exists) || exit 1

Useful links and references

Build PDF Documentation, Makefile tab:

https://dev.docs.pyansys.com/how-to/documenting.html#build-documentation

Additionally include the .PHONY: pdf in both the Makefile and make.bat files to facilitate proper execution in both environments.