Skip to main content

Tools for building the Ansible Distribution

Project description

Pygments lexer and style Ansible snippets

Python linting badge GitHub Actions CI/CD workflow Codecov badge

This project provides a Pygments lexer that is able to handle Ansible output. It may be used anywhere Pygments is integrated. The lexer is registered globally under the name ansible-output.

It also provides a Pygments style for tools needing to highlight code snippets.

The code is licensed under the terms of the BSD 2-Clause license.

Using the lexer in Sphinx

Make sure this library in installed in the same env as your Sphinx automation via pip install ansible-pygments sphinx. Then, you should be able to use a lexer by its name ansible-output in the code blocks of your RST documents. For example:

.. code-block:: ansible-output

    [WARNING]: Unable to find '/nosuchfile' in expected paths (use -vvvvv to see paths)

    ok: [localhost] => {
        "msg": ""
    }

Using the style in Sphinx

It is possible to just set ansible in conf.py and it will "just work", provided that this project is installed alongside Sphinx as shown above.

pygments_style = 'ansible'

Project details


Download files

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

Source Distribution

ansible-pygments-0.1.0a1.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

ansible_pygments-0.1.0a1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file ansible-pygments-0.1.0a1.tar.gz.

File metadata

  • Download URL: ansible-pygments-0.1.0a1.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for ansible-pygments-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 399407f7b6ce8fc7e733b629742b7be2b7db3392e15161bad7056bac820ed033
MD5 73c85d2fb4d2ae00349418a654d47d12
BLAKE2b-256 a98435ed5be9865ec872c5fed0a6b57e2df513b63fc28b9571274199121f43fc

See more details on using hashes here.

File details

Details for the file ansible_pygments-0.1.0a1-py3-none-any.whl.

File metadata

  • Download URL: ansible_pygments-0.1.0a1-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for ansible_pygments-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 1203d25d63e0b4680740489e46547c6ebff3bd13ab0e3e405c6a7aca4bc4cf41
MD5 4d24dda037a588e59fd1a8b24c53b48b
BLAKE2b-256 196c517f9b834e67056bbbe3f8ae8398c2a9fd60c1ebe1a95a7aaaa35f9dcb09

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page