0da13469d3
* Add a script to update the intersphinx inventory files * We're about to add intersphinx inventories for separate ansible docs so we need an easy way to update them. Also, we should be updating these cache files for other upstreams occassionally as well. With a script, we can add updating them to a release process. * Now that we don't know what the version of the cache is, change the filenames to not contain versions. * Update the intersphinx cache files with the latest upstream versions Results of running: hacking/build-ansible.py update-intersphinx-cache -o docs/docsite -c docs/docsite/rst/conf.py * Add a comment to the configuration file which says how to structure the intersphinx mapping and why. * Update docs/docsite/rst/conf.py Co-Authored-By: Sandra McCann <samccann@redhat.com> Co-authored-by: Sandra McCann <samccann@redhat.com> |
5 years ago | |
|---|---|---|
| .. | ||
| _extensions | 6 years ago | |
| _static | 5 years ago | |
| _themes/sphinx_rtd_theme | 5 years ago | |
| js/ansible | 8 years ago | |
| rst | 5 years ago | |
| .gitignore | 7 years ago | |
| .nojekyll | 8 years ago | |
| Makefile | 5 years ago | |
| Makefile.sphinx | 7 years ago | |
| README.md | 5 years ago | |
| jinja.inv | 5 years ago | |
| keyword_desc.yml | 5 years ago | |
| modules.js | 8 years ago | |
| python2.inv | 5 years ago | |
| python3.inv | 5 years ago | |
| requirements.txt | 5 years ago | |
| variables.dot | 8 years ago | |
README.md
Ansible documentation
This project hosts the source behind docs.ansible.com.
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.
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. For GitHub workflows and other information, see the GitHub Guides.