From ebc676bacb29c5c9d1dd1e6bed4b5b98c43dfe0c 2013-03-23 22:58:31 From: Takafumi Arakaki Date: 2013-03-23 22:58:31 Subject: [PATCH] Add info make target that was missing in old Sphinx --- diff --git a/docs/Makefile b/docs/Makefile index 8ffb60f..6ae59a5 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -23,6 +23,8 @@ help: @echo " pickle to make pickle files (usable by e.g. sphinx-web)" @echo " htmlhelp to make HTML files and a HTML help project" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" @echo " changes to make an overview over all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo @@ -119,3 +121,18 @@ nightly: dist gh-pages: clean html python gh-pages.py + +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." diff --git a/docs/source/conf.py b/docs/source/conf.py index 20adecb..8bc75fd 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -208,6 +208,19 @@ latex_documents = [ latex_use_modindex = True +# Options for texinfo output +# -------------------------- + +texinfo_documents = [ + (master_doc, 'ipython', 'IPython Documentation', + 'The IPython Development Team', + 'IPython', + 'IPython Documentation', + 'Programming', + 1), +] + + # Cleanup # ------- # delete release info to avoid pickling errors from sphinx