Tools for building the Ansible Distribution
Project description
Pygments lexer and style Ansible snippets
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ansible_pygments-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85aa7412a46c83efcfe460c8016da289600c171d2edfa0f474e0dc30a398b002 |
|
MD5 | 575512ca618f836d099bba80e1449c53 |
|
BLAKE2b-256 | 5c8ad053d64b37b5b3859b5a883afec0ec4a41bfbc5d623a8efb5d343d99612d |