Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

Extract Ansible module documentation

Project description

This package contains code for Ansible collection documentation extractor. Its main audience are Ansible collection maintainers that would like to publish API docs in the HTML form without having to manually copy the data already present in the module’s metadata.

Quickstart

Documentation extractor is published on PyPI and we can install it using pip:

$ pip install ansible-doc-extractor

If the previous command did not fail, we are ready to start extracting the documentation:

$ ansible-doc-extractor \
    /tmp/output-folder \
    ~/.ansible/collections/ansible_collections/my/col/plugins/modules/*.py

This will extract the documentation from modules in my.col collection and place resulting rst files into /tmp/output-folder.

Note

Always extract documentation from installed collection. Documentation fragment loader fails to combine various parts of the documentation otherwise.

Custom template

ansible-doc-extractor supports a custom Jinja2 template file via --template. The following variables are sent to the template:

Variable name Type Description Module’s documentation key
short_description str Short description of a module. short_description
description str / list Longer description of a module, type depends on the module’s description type. description
requirements list Requirements needed on the host that executes this module. requirements
options dict All module options, often called parameters or arguments. options
notes list Module’s additional notes. notes
seealso list Details of any important information that doesn’t fit in one of the above sections. seealso
deprecated str Marks modules that will be removed in future releases deprecated
author str / list Author of the module, type can vary depending on how many authors module has. author
metadata dict This section provides information about the module Refers to ANSIBLE_METADATA block in the module.
examples str Code examples Refers to EXAMPLES block in the module.
returndocs dict This section documents the information the module returns. Refers to RETURN block in the module.

You can always refer to the default Jinja2 template.

Development setup

Getting development environment up and running is relatively simple if we have pipenv installed:

$ pipenv update

To test the extractor, we can run:

$ pipenv run ansible-doc-extractor

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 ansible-doc-extractor, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size ansible_doc_extractor-0.1.5-py3-none-any.whl (18.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size ansible-doc-extractor-0.1.5.tar.gz (18.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page