diff --git a/doc/Makefile b/doc/Makefile index 310c5ee..5a777c0 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -15,60 +15,32 @@ PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest latexpdf -.PHONY: all install +.PHONY: html pdf all help clean dirhtml latex + + +all: html pdf + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html + cd $(BUILDDIR)/latex && make all-pdf + cp -pr $(BUILDDIR)/latex/asteval.pdf $(BUILDDIR)/html/asteval.pdf + @echo + -cd $(BUILDDIR) && ln -s html asteval_doc && zip -pur asteval_doc.zip asteval_doc/* && mv asteval_doc.zip html && rm -f asteval_doc + @echo "Build finished. The HTML pages are in _build/html." html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." -asteval.pdf: latex +pdf: latex cd $(BUILDDIR)/latex && make all-pdf cp -pr $(BUILDDIR)/latex/asteval.pdf ./asteval.pdf -all: html - -install: all - cp -pr $(BUILDDIR)/latex/asteval.pdf $(INSTALLDIR)/asteval.pdf - cp -pr $(BUILDDIR)/html/* $(INSTALLDIR)/. - 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 " 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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @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 $(BUILDDIR)/* - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -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." + @echo " pdf pdf from latex version" + @echo " all html, pdf, and doc.zip" + @echo " clean to remove all output" latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex @@ -83,18 +55,5 @@ latexpdf: make -C _build/latex all-pdf @echo "pdflatex finished; the PDF files are in _build/latex." -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." +clean: + -rm -rf _build/* diff --git a/doc/_templates/indexsidebar.html b/doc/_templates/indexsidebar.html index 6b099aa..645bfa1 100644 --- a/doc/_templates/indexsidebar.html +++ b/doc/_templates/indexsidebar.html @@ -9,9 +9,16 @@

Contents

Get Asteval

Current version: {{ release }}

-

Install: pip install asteval

+

Install: pip install asteval

Develop:   github.com

+

Offline Documentation

+ +

+ PDF documentation +
+ Zipped HTML and PDF +