Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: make documentation friendlier for tools like doc2dash #3601

Closed
vmalloc opened this issue Jul 20, 2013 · 5 comments
Closed

Comments

@vmalloc
Copy link

vmalloc commented Jul 20, 2013

It would be nice to be able to create a quick module reference for tools like Dash (http://kapeli.com/dash). Dash provides its own doc2dash python package for quickly converting sphinx-documented projects to Dash docsets. Unfortunately it seems Ansible's documentation isn't trivial to process using doc2dash.

@mpdehaan
Copy link
Contributor

I haven't heard of this before and it isn't something I think we're likely to work on, given I don't know of anyone using this.

@chrisberkhout
Copy link
Contributor

I love Dash. It's Mac only, but there's a clone for Linux and Windows that reads the same docset format: Zeal.

@vmalloc now has now built an Ansible docset. It's a bit out of date (v1.2.1) and the index page should probably be populated like the contents page, but it's still helpful. Thanks!

@drewda
Copy link

drewda commented Nov 6, 2013

Thanks for making an Ansible docset, @vmalloc

(I've been getting great use out of Dash and am glad to see more and more others doing the same!)

@vmalloc
Copy link
Author

vmalloc commented Nov 6, 2013

You're welcome. I only regret that the documentation is so hard to convert via doc2dash, and requires some hacky preprocessing.

@patrickheeney
Copy link
Contributor

I found this via a google search. I would also be interested in this. Using the site for documentation now is pretty painful when used to a tool like dash. I find it difficult to find anything except for module information on the docs.

robinro pushed a commit to robinro/ansible that referenced this issue Dec 9, 2016
@ansible ansible locked and limited conversation to collaborators Apr 24, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants