Commit cc692865 authored by Lev Lamberov's avatar Lev Lamberov

New upstream version 0.2.7

parents
sudo: false
language: python
python:
- "2.7"
- "3.4"
- "3.5"
env:
matrix:
- EVM_EMACS=emacs-24.3-travis
- EVM_EMACS=emacs-24.4-travis
- EVM_EMACS=emacs-24.5-travis
global:
# Turn on --use-mirrors option everywhere (even in tox):
- PIP_USE_MIRRORS=t
# Use Python version of the one used for running tox
- TOXENV=py
matrix:
allow_failures:
- python: "3.5"
before_install:
- pip install -q virtualenv tox
- curl -fsSkL https://gist.github.com/rejeep/ebcd57c3af83b049833b/raw > x.sh && source ./x.sh
- evm install $EVM_EMACS --use --skip
- cask
- make before-test
script:
make travis-ci
# Contribution guide line
## Where should I ask question about Jedi.el?
Please ask question in [StackOverflow with `emacs-jedi` tag][so-tag].
However, you may find some old questions in GitHub issue tracker so it
is worth searching in it.
[so-tag]: http://stackoverflow.com/questions/tagged/emacs-jedi
## Bug report / Question
- Check [troubleshooting][troubleshooting] section first.
[troubleshooting]: http://tkf.github.io/emacs-jedi/latest/#troubleshooting
## Pull request
- After you submit a pull request, check the tests on Travis CI.
If you find an error you can fix, please do it.
- Use PEP 8 style in Python file.
- Make sure that Emacs Lisp file compiles without *warning*
(at least make sure you don't increase the number of warnings).
(source gnu)
(source melpa)
(package "jedi" "0" "A Python auto-completion for Emacs")
(development
(depends-on "ert")
(depends-on "epc")
(depends-on "auto-complete")
(depends-on "python-environment")
(depends-on "mocker"))
ENV = env
VIRTUALENV_SYSTEM_SITE_PACKAGES ?= true
VIRTUALENV = \
VIRTUALENV_SYSTEM_SITE_PACKAGES=$(VIRTUALENV_SYSTEM_SITE_PACKAGES) \
virtualenv --python=$(PYTHON)
PIP_INSTALL = $(ENV)/$(BINDIR)/pip install
JEDI_DEV_URL = https://github.com/davidhalter/jedi/archive/dev.zip
PYTHON ?= python
CASK ?= cask
export EMACS ?= emacs
BINDIR ?= bin
ELPA_DIR = \
.cask/$(shell ${EMACS} -Q --batch --eval '(princ emacs-version)')/elpa
# See: cask-elpa-dir
VIRTUAL_EMACS = ${CASK} exec ${EMACS} -Q \
--eval "(setq python-environment--verbose t)" \
--eval "(setq jedi:environment-root \"$(PWD)/$(ENV)\")"
.PHONY : test test-1 tryout clean-elpa requirements env clean-env clean \
print-deps travis-ci doc
TEST_DEPS = elpa env
test: ${TEST_DEPS}
${MAKE} test-1
test-1:
${VIRTUAL_EMACS} -batch \
-L . -l test-jedi.el -f ert-run-tests-batch-and-exit
tox
compile: elpa clean-elc
${VIRTUAL_EMACS} -batch \
-L . -f batch-byte-compile *.el
clean-elc:
rm -rf *.elc
tryout: compile env
${VIRTUAL_EMACS} -L . -l tryout-jedi.el
doc: elpa
make -C doc html
ensure-git:
test -d .git # Running task that can be run only in git repository
elpa: ${ELPA_DIR}
${ELPA_DIR}: Cask
${CASK} install
test -d $@
touch $@
clean-elpa:
rm -rf ${ELPA_DIR}
requirements:
@echo "**************************************************************"
@echo " ERROR: \"make requirements\" is obsolete!"
@echo " Please run \"M-x jedi:install-server\" inside of your Emacs."
@echo " * If you are using el-get, please update it first."
@echo " See also: https://github.com/dimitri/el-get/pull/1603"
@echo "**************************************************************"
@exit 1
install-jedi-dev:
${PIP_INSTALL} --upgrade ${JEDI_DEV_URL}
env: $(ENV)/$(BINDIR)/jediepcserver
$(ENV)/$(BINDIR)/jediepcserver: ${ELPA_DIR} jediepcserver.py setup.py
${VIRTUAL_EMACS} -batch -L . -l jedi.el -f "jedi:install-server-block"
test -f $@
clean-env:
rm -rf $(ENV)
clean-el: clean-elpa clean-elc
clean: clean-env clean-el
rm -rf .cask
print-deps: elpa env
@echo "----------------------- Dependencies -----------------------"
$(EMACS) --version
${VIRTUAL_EMACS} -batch -L . -l jedi.el -f jedi:print-jedi-version
-ls -d $(ENV)/*/python*/site-packages/*egg-info
@echo "------------------------------------------------------------"
before-test: ${TEST_DEPS}
tox --notest
travis-ci: print-deps test
test ! -d ~/.emacs.d/.python-environments
# Run test against Emacs listed in ${EMACS_LIST}.
# This is for running tests for multiple Emacs versions.
# This is not used in Travis CI. Usage::
#
# make EMACS_LIST="emacs emacs-snapshot emacs23" test-all
#
# See: http://stackoverflow.com/a/12110773/727827
#
# Use ${MET_MAKEFLAGS} to do the tests in parallel.
#
# MET_MAKEFLAGS=-j4
JOBS := $(addprefix job-,${EMACS_LIST})
.PHONY: ${JOBS}
${JOBS}: job-%:
${MAKE} EMACS=$* clean-elc elpa
${MAKE} EMACS=$* ${MET_MAKEFLAGS} test-1
test-all: env ${JOBS}
### Packaging
#
# Create dist/${PACKAGE}-${VERSION}.tar.gz ready for distribution.
#
# See: (info "(elisp) Multi-file Packages")
PACKAGE = jedi
VERSION = $(shell grep ';; Version:' jedi.el | sed 's/^.* \([0-9].*\)$$/\1/')
DIST_FILES = jedi-pkg.el jedi.el jediepcserver.py \
Makefile tryout-jedi.el
.PHONY: dist ${PACKAGE}-${VERSION}.tar.gz ${PACKAGE}-${VERSION} \
clean-dist clean-dist-all
dist: clean-dist
${MAKE} dist-1
dist-1: dist/${PACKAGE}-${VERSION}.tar dist/${PACKAGE}-${VERSION}.tar.gz
dist/${PACKAGE}-${VERSION}.tar: ${PACKAGE}-${VERSION}.tar
${PACKAGE}-${VERSION}.tar: ${PACKAGE}-${VERSION}
tar --directory dist -cvf dist/$@ $<
dist/${PACKAGE}-${VERSION}.tar.gz: ${PACKAGE}-${VERSION}.tar.gz
${PACKAGE}-${VERSION}.tar.gz: ${PACKAGE}-${VERSION}
tar --directory dist -cvzf dist/$@ $<
${PACKAGE}-${VERSION}: dist/${PACKAGE}-${VERSION}
dist/${PACKAGE}-${VERSION}:
mkdir -p $@
cp -v ${DIST_FILES} $@
clean-dist:
rm -rf dist/${PACKAGE}-${VERSION}*
clean-dist-all:
rm -rf dist
### Package installation
PACKAGE_USER_DIR =
TEST_PACKAGE_DIR = dist/test
install-dist:
test -d '${PACKAGE_USER_DIR}'
${EMACS} --batch -Q \
-l package \
--eval " \
(add-to-list 'package-archives \
'(\"marmalade\" . \"http://marmalade-repo.org/packages/\") t)" \
--eval '(setq package-user-dir "${PWD}/${PACKAGE_USER_DIR}")' \
--eval '(package-list-packages)' \
--eval '(package-install-file "${PWD}/dist/${PACKAGE}-${VERSION}.tar")'
test-install: dist/${PACKAGE}-${VERSION}.tar
rm -rf ${TEST_PACKAGE_DIR}
mkdir -p ${TEST_PACKAGE_DIR}
${MAKE} install-dist PACKAGE_USER_DIR=${TEST_PACKAGE_DIR}
test-install-requirement: test-install
${MAKE} --directory ${TEST_PACKAGE_DIR}/${PACKAGE}-${VERSION} \
requirements
### GH pages
MAKE_GH_PAGES = $(MAKE) --directory doc --file gh-pages.mk
gh-pages-latest:
$(MAKE_GH_PAGES)
# Publish released documentation. This task can be run only when the
# current revision has tag (i.e., released).
gh-pages-released:
# Make sure it's on tag
git describe --tags --dirty | grep -v -
# Run doc/gh-pages.mk
$(MAKE_GH_PAGES) DOC_VER=released
============================================
Jedi.el - Python auto-completion for Emacs
============================================
.. sidebar:: Links:
* `Documentation (dev) <http://tkf.github.io/emacs-jedi/latest>`_
(`released version <http://tkf.github.io/emacs-jedi/released>`_)
* `Screenshots <http://tkf.github.io/emacs-jedi/latest#screenshots>`_
* `Configuration <http://tkf.github.io/emacs-jedi/latest#configuration>`_
* `Command <http://tkf.github.io/emacs-jedi/latest#command>`_
* `FAQ <http://tkf.github.io/emacs-jedi/latest#faq>`_
* `Troubleshooting <http://tkf.github.io/emacs-jedi/latest#troubleshooting>`_
* `Complete overview <http://tkf.github.io/emacs-jedi/latest/contents.html>`_
* `Changelog <http://tkf.github.io/emacs-jedi/latest/changelog.html>`_
* `Q & A in StackOverflow
<http://stackoverflow.com/questions/tagged/emacs-jedi>`_
(with ``emacs-jedi`` tag)
* `Repository <https://github.com/tkf/emacs-jedi>`_ (at GitHub)
* `Issue tracker <https://github.com/tkf/emacs-jedi/issues>`_ (at GitHub)
* `Travis CI <https://travis-ci.org/tkf/emacs-jedi>`_ |build-status|
* `MELPA <https://melpa.org/#/jedi-jedi>`_ |melpa-badge|
* `MELPA Stable <https://stable.melpa.org/#/jedi>`_ |melpa-stable-badge|
What is it?
===========
Jedi.el is a Python auto-completion package for Emacs.
It aims at helping your Python coding in a non-destructive way.
It also helps you to find information about Python objects, such as
docstring, function arguments and code location.
For more info, read documentation.
If you are using developmental version installed via el-get or MELPA, read
the `developmental version <http://tkf.github.io/emacs-jedi/latest>`_.
If you are using released version installed via Marmalade, read
the `released version <http://tkf.github.io/emacs-jedi/released>`_.
.. figure:: http://farm9.staticflickr.com/8261/8804536872_8d266b88ed_o.png
Auto-completion using Jedi.el.
See more screenshots
`here <http://tkf.github.io/emacs-jedi/latest#screenshots>`_.
Company Users
=============
**NOTE: Please do not install 'jedi' package for company users. You should install only company-jedi.**
If you use `company <https://github.com/company-mode/company-mode>`_,
please see `company-jedi <https://github.com/syohex/emacs-company-jedi>`_.
.. Build status badge
.. |build-status|
image:: https://secure.travis-ci.org/tkf/emacs-jedi.png?branch=master
:target: http://travis-ci.org/tkf/emacs-jedi
:alt: Build Status
.. |melpa-badge|
image:: http://melpa.org/packages/jedi-badge.svg
:target: http://melpa.org/#/jedi
:alt: MELPA Badge
.. |melpa-stable-badge|
image:: http://stable.melpa.org/packages/jedi-badge.svg
:target: http://stable.melpa.org/#/jedi
:alt: MELPA Stable Badge
import shutil
import tempfile
import pytest
@pytest.fixture(scope='session')
def clean_jedi_cache(request):
"""
Set `jedi.settings.cache_directory` to a temporary directory during test.
Note that you can't use built-in `tmpdir` and `monkeypatch`
fixture here because their scope is 'function', which is not used
in 'session' scope fixture.
This fixture is activated in tox.ini.
"""
import jedi
settings = jedi.settings
old = settings.cache_directory
tmp = tempfile.mkdtemp(prefix='jedi-test-')
settings.cache_directory = tmp
@request.addfinalizer
def restore():
settings.cache_directory = old
shutil.rmtree(tmp)
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle \
json htmlhelp qthelp devhelp epub latex latexpdf \
text man changes linkcheck doctest gettext \
help:
@echo "Please use \`make <target>' where <target> 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 " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@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)/*/*
html: releases
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
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."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/EmacsJedi.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/EmacsJedi.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/EmacsJedi"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/EmacsJedi"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(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:
$(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:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
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:
$(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."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
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."
## Generate contributions list
RELEASES = $(wildcard source/releases/v*)
RELEASES_AUTHORS = $(addsuffix /authors.txt, $(RELEASES))
RELEASES_CLOSED = $(addsuffix /closed.txt, $(RELEASES))
ISSUE_URL = https://github.com/tkf/emacs-jedi/issues
.PHONY: releases FORCE
releases: $(RELEASES_AUTHORS) $(RELEASES_CLOSED)
source/releases/%/authors.txt: source/releases/%/range Makefile
git log --format='format:%an' $$(cat $<) \
| grep --invert-match "Takafumi Arakaki" \
| sort --unique \
| sed 's/\(.*\)/- `\1`_/' \
> $@
source/releases/%/closed.txt: source/releases/%/range Makefile
git log --format='format:%s %b' --grep='#[0-9]\+' $$(cat $<) \
| grep -e 'fix\(es\)\?' -e 'pull request' \
| grep --extended-regexp --only-matching '#[0-9]+' \
| grep --extended-regexp --only-matching '[0-9]+' \
| sort --unique \
| sort --numeric-sort \
| sed 's%\(.*\)%`#\1 <$(ISSUE_URL)/\1>`_%' \
> $@
# Run these two targets unconditionally. See (info "(make) Force Targets")
# Since source/releases/v0.2.0/range has no end, the result may differ
# every time they are run.
# To skip these targets, run make with "RELEASES=".
source/releases/v0.2.0/authors.txt: FORCE
source/releases/v0.2.0/closed.txt: FORCE
# Load other makefiles. See: (info "(make) Include")
include *.mk
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="refresh" content="1; url=latest">
<script type="text/javascript">
window.location.href = "latest"
</script>
<title>Page Redirection</title>
</head>
<body>
If you are not redirected automatically, follow the
<a href='latest'>link to latest</a> or
<a href='released'>link to released</a>
</body>
</html>
## Usage
# Usage 1:
# * Put this file in Sphinx's directory (where you find Makefile).
# * Add "include *.mk" to Sphinx's Makefile.
# Usage 2:
# * Run make like this: make -f gh-pages.mk [TARGET]
## Configuration
REPO_URL = git@github.com:tkf/emacs-jedi.git
REPO_DIR = gh-pages
# $(DOC_VER) can be "released", "v1.0", etc.:
DOC_VER = latest
DOC_DIR = $(REPO_DIR)/$(DOC_VER)
DOC_PORT = 7563
## Misc variables
# To use this file from --file option, let's define variables in
# Sphinx's Makefile, if they are not defined:
ifndef BUILDDIR
BUILDDIR = build
endif
## Targets
.PHONY: _gh-pages-assert-repo gh-pages-update gh-pages-push \
gh-pages-clone gh-pages-pull gh-pages-all \
gh-pages-root gh-pages-root-commit
.NOTPARALLEL: gh-pages-all
gh-pages-all: gh-pages-pull gh-pages-update gh-pages-push
# Check if $(REPO_DIR) is really a git repository. Otherwise,
# committing files in there is pretty dangerous as it might goes into
# REPO's master branch.
_gh-pages-assert-repo:
test -d $(REPO_DIR)/.git
gh-pages-clone:
rm -rf $(REPO_DIR)
git clone --branch gh-pages $(REPO_URL) $(REPO_DIR)
gh-pages-pull: _gh-pages-assert-repo
cd $(REPO_DIR) && git pull
gh-pages-update: _gh-pages-assert-repo
$(MAKE) clean html
@echo "Clean $(DOC_DIR)"
test ! -d $(DOC_DIR)/.git
rm -rf $(DOC_DIR)
@echo "Copy files: $(BUILDDIR)/html -> $(DOC_DIR)"
cp -r $(BUILDDIR)/html $(DOC_DIR)
@echo "Update gh-pages"
cd $(DOC_DIR) && \
git add . && \
if [ -n "$$(git ls-files --deleted .)" ]; then \
git ls-files --deleted . | xargs git rm; \
fi && \
git commit -m "Update $(DOC_VER)"
gh-pages-push: _gh-pages-assert-repo
cd $(REPO_DIR) && git push -u origin gh-pages
## Root
gh-pages-root-commit: gh-pages-root
cd $(REPO_DIR) && \
git add *.* .nojekyll .gitignore && \
git commit -m "Update root page."
gh-pages-root: $(REPO_DIR)/index.html $(REPO_DIR)/.nojekyll
$(REPO_DIR)/index.html: gh-pages-index.html
cp $< $@
$(REPO_DIR)/.nojekyll:
touch $@
## Misc
gh-pages-serve:
bash -c 'sleep 0.1s; python -m webbrowser http://localhost:$(DOC_PORT)' &
cd $(REPO_DIR) && python -m SimpleHTTPServer $(DOC_PORT)
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
set I18NSPHINXOPTS=%SPHINXOPTS% source
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> 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. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over 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
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)