online docs

Would it make sense to have two versions of the docs online:
-latest release (1.0, or whichever)
-latest devel

I find myself wanting to use new modules, or new options that I've seen mentioned on the mailing list, but their doc isn't online yet - I can generate a local copy, but it'd be a lot more convenient to be able to just go online.

We'll have snapshotted docs at some point in the near future. It's
at least on the "these are things we need to do" queue.

I also want to consider overhauling the way we generate them, in
particular to make the modules stuff categorized, but also to improve
the usability to the doc site.

Until then, when adding features, using the versionadded attribute in
Sphinx is what we do.

--Michael

I find myself wanting to use new modules, or new options that I've
seen mentioned on the mailing list, but their doc isn't online yet

Are you aware of the `ansible-doc' utility? Shows the full docs of
locally available modules on the command-line, extracted directly from
the modules (i.e. no 'make' required). Typical uses:

ansible-doc -l Lists all modules
ansible-doc modulename Show doc for that module
ansible-doc -s modulename Show snippet for incl. into playbook

You're welcome. :wink:

        -JP

I find myself wanting to use new modules, or new options that I've
seen mentioned on the mailing list, but their doc isn't online yet

Are you aware of the `ansible-doc' utility? Shows the full docs of
locally available modules on the command-line, extracted directly from
the modules (i.e. no 'make' required). Typical uses:

ansible-doc -l Lists all modules
ansible-doc modulename Show doc for that module
ansible-doc -s modulename Show snippet for incl. into playbook

Thank you!

You're welcome. :wink:

No I wasn't aware of it. I just checked, this is not documented, is it? Is it fairly new? Where should we add it? In the main "docs" page?

No I wasn't aware of it. I just checked, this is not documented is it?

It even has a man-page :slight_smile:

Is it fairly new? Where should we add it? In the main "docs"
page?

        -JP