search

ansible / galaxy-dev

Ansible Automation Hub
11 stars 13 forks source link

Importer: Support restructuredText #190

Open chouseknecht opened 4 years ago

chouseknecht commented 4 years ago

Support README and other Collection level docs in .rst format. Based on feedback, this seems critical for the adoption of Collect Explorer (#182)

chouseknecht commented 4 years ago

Have a look at: https://github.com/xlab-si/ansible-doc-extractor. It's more about extracting doc strings from plugins, which we already do.

chouseknecht commented 4 years ago

This is sort of related to #182. Assigning to @newswangerd to work on as part of that story.

chouseknecht commented 4 years ago

The overall idea is to transform ReST docs into HTML using Python packages rather than full-blown Sphinx generation. Things we would like to support:

We also need to provide documentation and examples of how to document collections.