ccbfdec334
* excludes scenario guides from core docs, splits porting guides and roadmaps, symlinks indices to create index.html pages, and adds .gitignore entries for conf.py and the toplevel index.rst files generated by the docs build This solution builds three types of docs: * ansible-2.10 and earlier: all the docs. Handle this via `make webdocs ANSIBLE_VERSION=2.10` * ansible-3 and later: a subset of the docs for the ansible package. Handle this via `make webdocs ANSIBLE_VERSION=3` (change the ANSIBLE_VERSION to match the version being built for. * ansible-core: a subset of the docs for the ansible-core package. Handle this via `make coredocs`. * `make webdocs` now always builds all the collection docs * Use `make coredocs` to limit it to core plugins only * The user specifies the desired version. If no ANSIBLE_VERSION is specified, build plugins for the latest release of ansible Co-authored-by: Toshio Kuratomi <a.badger@gmail.com> Co-authored-by: Matt Clay <matt@mystile.com> |
4 years ago | |
|---|---|---|
| .. | ||
| _extensions | 4 years ago | |
| _static | 5 years ago | |
| _themes/sphinx_rtd_theme | 4 years ago | |
| js/ansible | 8 years ago | |
| rst | 4 years ago | |
| sphinx_conf | 4 years ago | |
| .gitignore | 4 years ago | |
| .nojekyll | 8 years ago | |
| Makefile | 4 years ago | |
| Makefile.sphinx | 4 years ago | |
| README.md | 4 years ago | |
| ansible_2_5.inv | 4 years ago | |
| ansible_2_6.inv | 4 years ago | |
| ansible_2_7.inv | 4 years ago | |
| ansible_2_8.inv | 4 years ago | |
| ansible_2_9.inv | 4 years ago | |
| ansible_2_10.inv | 4 years ago | |
| collection-plugins.yml | 4 years ago | |
| jinja2.inv | 5 years ago | |
| modules.js | 8 years ago | |
| python2.inv | 5 years ago | |
| python3.inv | 4 years ago | |
| requirements.txt | 4 years ago | |
| variables.dot | 8 years ago | |
README.md
Ansible documentation
This project hosts the source behind the general pages of docs.ansible.com. Module-specific documentation is hosted in the various collections repositories. See Ansible Galaxy, the list of Ansible-maintained collections, and the ansible-collections organization for collections sources.
To create clear, concise, and consistent contributions to Ansible documentation, please refer to the following information.
Contributions
Contributions to the documentation are welcome.
The Ansible community produces guidance on contributions, building documentation, and submitting pull requests, which you can find in Contributing to the Ansible Documentation.
You can also join the Docs Working Group and/or the #ansible-docs channel on freenode IRC.
Ansible style guide
Ansible documentation is written in ReStructuredText(RST). The Ansible style guide provides linguistic direction and technical guidelines for working with reStructuredText, in addition to other resources.
Tools
The Ansible community uses a range of tools and programs for working with Ansible documentation. Learn more about Other Tools and Programs in the Ansible Community Guide.
GitHub
Ansible documentation is hosted on the Ansible GitHub project and various collection repositories, especially those in the ansible-collections organization. For general GitHub workflows and other information, see the GitHub Guides.