Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Sphinx extension to lint shell code blocks

Project description

PyPI version License Python versions supported Format

Continuous integration test status Continuous integration test coverage

sphinxcontrib-shellcheck

The shellcheck Sphinx builder is an extension that uses the shellcheck utility to lint shell code in the documentation.

Interpreter

The extension has been developed and tested with Python 2.7, 3.5, 3.6 and 3.7 under Linux (Debian, Ubuntu), Apple macOS and Microsoft Windows

Installation

The extension is on PyPI, so:

$ pip install sphinxcontrib-shellcheck

Add the shellcheck extension to the extension list in your Sphinx conf.py file to enable it:

extensions = [
    ...
    "sphinxcontrib.shellcheck",
    ...
]

Usage

For example, if a reStructuredText file example.rst has the following content:

Follow these instructions:

    .. code-block:: bash

        $ github_user=myname
        $ git clone \
              https://github.com/"${github_user}"/ \
              myrepo.git
        Cloning into 'myrepo'...
        ...
        $ cd myrepo
        $ export MYREPO_DIR=${PWD}
        $ echo "${myvar}"

And all will be good

Then with the extension installed:

$ sphinx-build -b shellcheck . _build example.rst
Running Sphinx v1.8.3
making output directory...
building [mo]: targets for 0 po files that are specified
building [shellcheck]: 1 source files given on command line
updating environment: 4 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
example.rst
Line 11, column 11 [2164]: Use cd ... || exit in case cd fails.
Line 13, column 17 [2154]: myvar is referenced but not assigned.
build succeeded.

Look for any errors in the above output or in _build/shellcheck/output.txt

Configuration variables

These are the configurable variables of the extension:

  • shellcheck_dialects (list of strings): shell dialects to be linted. The default dialects are those supported by shellcheck, ["sh", "bash", "dash", "ksh"], and only a subset of these is valid.
  • shellcheck_executable (string): name of the shellcheck executable (potentially full path to it too). The default is "shellcheck".
  • shellcheck_prompt (string): single character representing the terminal prompt. The default is $.
  • shellcheck_debug (integer): flag that indicates whether debug information shall be printed via the Sphinx logger (1) or not (0). The default is 0. This configuration option is only useful while developing the extension.

These configuration variables can be overriden via the Sphinx configuration file conf.py, or via the -D option of the sphinx-build command. For example:

$ sphinx-build -b shellcheck \
   -D shellcheck_dialects=bash,ksh \
   -D shellcheck_executable=shellcheck-stable \
   -D shellcheck_prompt=$ \
   -D shellcheck_debug=1 \
   . _build example.rst

License

The MIT License (MIT)

Copyright (c) 2018-2019, Pablo Acosta-Serafini All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the <organization> nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Changelog

  • 1.0.10 [March 27, 2019] Correctly set exit code when there are errors
  • 1.0.9 [March 18, 2019] Changed debug parameter default status
  • 1.0.8 [March 17, 2019] Package management update
  • 1.0.7 [March 17, 2019] Package management update
  • 1.0.6 [March 17, 2019] Added check of shellcheck minimum version. Updated package management and testing framework
  • 1.0.5 [January 4, 2019] Initial public release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-shellcheck, version 1.0.10
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_shellcheck-1.0.10-py27-none-any.whl (10.0 kB) File type Wheel Python version py27 Upload date Hashes View hashes
Filename, size sphinxcontrib_shellcheck-1.0.10-py35-none-any.whl (10.0 kB) File type Wheel Python version py35 Upload date Hashes View hashes
Filename, size sphinxcontrib_shellcheck-1.0.10-py36-none-any.whl (11.4 kB) File type Wheel Python version py36 Upload date Hashes View hashes
Filename, size sphinxcontrib_shellcheck-1.0.10-py37-none-any.whl (11.4 kB) File type Wheel Python version py37 Upload date Hashes View hashes
Filename, size sphinxcontrib-shellcheck-1.0.10.zip (348.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page