Skip to main content

MkDocs Plugin that automatically generates pages for Ansible Collections.

Project description

MkDocs Ansible Collection

MkDocs Plugin that automatically generates pages for Ansible Collections. Uses metadata exported by the ansible-doc tool.

Work in Progress

This plugin is under initial development - you can track progress towards the first functional release here.

Its latest functionality can be seen live on the docs website.

Developing

To set up the development environment, run the following commands in the project root:

poetry install
poetry run mkdocs serve

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

mkdocs_ansible_collection-0.1.3.tar.gz (7.0 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_ansible_collection-0.1.3-py3-none-any.whl (12.2 kB view hashes)

Uploaded Python 3

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