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

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.

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


Release history Release notifications

This version

0.1.0

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.0
Filename, size File type Python version Upload date Hashes
Filename, size ansible_doc_extractor-0.1.0-py3-none-any.whl (17.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size ansible-doc-extractor-0.1.0.tar.gz (16.5 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