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.
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 | 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-doc-extractor-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 315ee447793b68dfeb6e4023b2a9561b95f7b3e805af688178e0f6054dcd242c |
|
MD5 | 49ceb036636ceb3b585c4643e79d2229 |
|
BLAKE2b-256 | f0d8e4bdf2d420fcf820e89934c856aea63849ac43a9d1c8608fa99e7507fb55 |
Hashes for ansible_doc_extractor-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b7af559c9635d6b3f2f4947b1464fbef5b2fee225219ac170e7a814b42e4bc3 |
|
MD5 | e70451591d874774ed8585bac6f0d68c |
|
BLAKE2b-256 | c9d8ca0cb03426ce7bf7db8b3351f1d3ce1948359a2b61206861eb4d1199715b |