##// END OF EJS Templates
Merge pull request #9106 from jamesfe/issue_9085_deprecationfix...
Merge pull request #9106 from jamesfe/issue_9085_deprecationfix Undo Testing Deprecation Warning for onlyif_cmds_exist

File last commit:

r21749:3c462799
r21880:e188f4c7 merge
Show More
Makefile
160 lines | 5.2 KiB | text/x-makefile | MakefileLexer
Brian E Granger
Beginning to organize the rst documentation.
r1256 # Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
Fernando Perez
Update docs for automatic API building.
r1850 SRCDIR = source
Rustam Safin
Add qthelp docs creation.
r8944 BUILDDIR = build
Fix for docs/Makefile hard-codes usage of "python" #8857
r21749 PYTHON = python
Brian E Granger
Beginning to organize the rst documentation.
r1256
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
Fernando Perez
Update docs for automatic API building.
r1850 ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SRCDIR)
Brian E Granger
Beginning to organize the rst documentation.
r1256
Fernando Perez
Update docs for automatic API building.
r1850 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck api
Brian E Granger
Beginning to organize the rst documentation.
r1256
Fernando Perez
Several small fixes during code review with Brian....
r2339 default: html
Brian E Granger
Beginning to organize the rst documentation.
r1256 help:
@echo "Please use \`make <target>' where <target> is one of"
Paul Ivanov
update help to include html_noapi target
r12940 @echo " html standalone HTML files"
@echo " html_noapi same as above, without the time consuming API docs"
@echo " pickle pickle files (usable by e.g. sphinx-web)"
@echo " htmlhelp HTML files and a HTML help project"
@echo " latex LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " texinfo Texinfo files"
@echo " info Texinfo files and run them through makeinfo"
@echo " changes an overview over all changed/added/deprecated items"
@echo " linkcheck check all external links for integrity (takes a long time)"
Matthias Bussonnier
more docs on building docs
r20903 @echo " gh-pages clone IPython docs in ./gh-pages/ , build doc, autocommit"
Fernando Perez
Fixes to build/setup machinery....
r1525 @echo
@echo "Compound utility targets:"
@echo "pdf latex and then runs the PDF generation"
@echo "all html and pdf"
@echo "dist all, and then puts the results in dist/"
Brian E Granger
Beginning to organize the rst documentation.
r1256
Thomas Kluyver
Allow incremental builds of the html_noapi docs target
r13458 clean_api:
-rm -rf $(SRCDIR)/api/generated
clean: clean_api
-rm -rf build/* dist/*
Min RK
fix xargs call on BSD...
r20272 -cd $(SRCDIR)/config/options; test -f generated && cat generated | xargs rm -f
Thomas Kluyver
Generate docs for config options.
r13459 -rm -rf $(SRCDIR)/config/options/generated
Thomas Kluyver
Generate documentation of line & cell magics
r18294 -rm -f $(SRCDIR)/interactive/magics-generated.txt
Brian E Granger
Beginning to organize the rst documentation.
r1256
Fernando Perez
Fixes to build/setup machinery....
r1525 pdf: latex
cd build/latex && make all-pdf
all: html pdf
Fernando Perez
Disable PDF manual building for distribution and installation....
r4453 # For final distribution, only build HTML (our pdf is now so large as to be
# unusable, takes forever to build and just bloats the downloads). We leave
# them hardlinked at the top-level so users find them easily, though the
# original build/html dir is left in-place (useful to reload builds while
# testing).
dist: html
rm -rf html
cp -al build/html .
@echo "Build finished. Final docs are in html/"
Fernando Perez
Fixes to build/setup machinery....
r1525
Thomas Kluyver
Remove docs infrastructure for jsdoc...
r21277 html: api autoconfig automagic
Thomas Kluyver
Generate documentation of line & cell magics
r18294 html_noapi: clean_api autoconfig automagic
Dav Clark
Added a lightweight "core" Makefile entry...
r12532
Dav Clark
Modified recipe so api is always executed first...
r12551 html html_noapi:
Brian E Granger
Beginning to organize the rst documentation.
r1256 mkdir -p build/html build/doctrees
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
@echo
@echo "Build finished. The HTML pages are in build/html."
Thomas Kluyver
Generate documentation of line & cell magics
r18294 automagic: source/interactive/magics-generated.txt
Thomas Kluyver
Various improvements to docs infrastructure for magics
r18296 source/interactive/magics-generated.txt: autogen_magics.py
Fix for docs/Makefile hard-codes usage of "python" #8857
r21749 $(PYTHON) autogen_magics.py
Thomas Kluyver
Generate documentation of line & cell magics
r18294 @echo "Created docs for line & cell magics"
Thomas Kluyver
Generate docs for config options.
r13459 autoconfig: source/config/options/generated
source/config/options/generated:
Fix for docs/Makefile hard-codes usage of "python" #8857
r21749 $(PYTHON) autogen_config.py
Thomas Kluyver
Generate docs for config options.
r13459 @echo "Created docs for config options"
Paul Ivanov
fix api docs post txt -> rst rename
r11758 api: source/api/generated/gen.txt
Fernando Perez
Fix Makefile so pdf docs build out of the box.
r2535
Paul Ivanov
fix api docs post txt -> rst rename
r11758 source/api/generated/gen.txt:
Fix for docs/Makefile hard-codes usage of "python" #8857
r21749 $(PYTHON) autogen_api.py
Fernando Perez
Update docs for automatic API building.
r1850 @echo "Build API docs finished."
Brian E Granger
Beginning to organize the rst documentation.
r1256 pickle:
mkdir -p build/pickle build/doctrees
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
@echo
@echo "Build finished; now you can process the pickle files or run"
@echo " sphinx-web build/pickle"
@echo "to start the sphinx-web server."
web: pickle
htmlhelp:
mkdir -p build/htmlhelp build/doctrees
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in build/htmlhelp."
Rustam Safin
Add qthelp docs creation.
r8944 qthelp:
mkdir -p build/qthelp
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/IPython.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/IPython.qhc"
Thomas Kluyver
Generate docs for config options.
r13459 latex: api autoconfig
Brian E Granger
Beginning to organize the rst documentation.
r1256 mkdir -p build/latex build/doctrees
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
@echo
@echo "Build finished; the LaTeX files are in build/latex."
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex."
changes:
mkdir -p build/changes build/doctrees
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
@echo
@echo "The overview file is in build/changes."
linkcheck:
mkdir -p build/linkcheck build/doctrees
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
Paul Ivanov
update indexes to use .rst, remove .txt refs
r11730 "or in build/linkcheck/output.rst."
Fernando Perez
Add Git workflow docs from Gitwash....
r2599
Fernando Perez
Major overhaul of the messaging documentation.
r2735 nightly: dist
Fernando Perez
Update messaging doc with refinements about user variables/expressions.
r2893 rsync -avH --delete dist/ ipython:www/doc/nightly
MinRK
added gh-pages command for GitHub hosted sphinx docs
r3255
MinRK
gh-pages tweaks...
r4672 gh-pages: clean html
MinRK
require specifying the version for gh-pages...
r15316 # if VERSION is unspecified, it will be dev
# For releases, VERSION should be just the major version,
# e.g. VERSION=2 make gh-pages
Fix for docs/Makefile hard-codes usage of "python" #8857
r21749 $(PYTHON) gh-pages.py $(VERSION)
Takafumi Arakaki
Add info make target that was missing in old Sphinx
r10009
texinfo:
mkdir -p $(BUILDDIR)/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)."
info:
mkdir -p $(BUILDDIR)/texinfo
$(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."