reStructuredText: sphinx

This file is no longer maintained

This file exists only as a historic reference. Documentation for syntastic checkers is now included in the manual, please see :help syntastic-checkers in Vim.

---

Maintainer: Buck Evan buck@yelp.com

sphinx is a checker for documentation files written in the Sphinx dialect of reStructuredText, using the pseudoxml builder of sphinx-build. See the project's page for details.

Checker options

Unlike most other syntastic checkers, sphinx checks an entire project rather than the current file. The checker needs to know two paths to run: the source directory where the project's files are located, and the directory where the configuration file conf.py is located.

By default, the checker looks for conf.py in the base directory of the current file, then upwards in parent directories. If a configuration file is found and the file is readable, its base directory is assumed to be both the source directory and the configuration directory of the project.

If syntastic can't determine the source directory or the configuration directory, or if you want to override the autodetected paths, the following options take precedence over the detected values:

g:syntastic_rst_sphinx_source_dir (string; default: unset)

base directory of the project being checked

g:syntastic_rst_sphinx_config_dir (string; default: unset)

directory containing the conf.py file.

Notes

The checker creates output files in a temporary directory that is created the first time the checker is run, and is removed when Vim exits. If you need to change the location of this directory you can do so by exporting the environment variables TMPDIR or TMP (on UNIX and Mac OS-X), or TEMP (on Windows) before running Vim. Various index files are also cached in this directory, so it might be advantageous to avoid quitting Vim between checker runs.