57d5b8642a
* Add examples to YAMLSyntax; fix minor issues and improve wording I added proper titles to "Flow Collections" and "Block Scalars", because these are official YAML Terms, so people can find better help when having issues. I changed the "ignored newlines" to "folded newlines" because I think ignoring gives a wrong impression, especially since empty lines (more than one newline) are not ignored and have a special meaning. I added an example how to enforce a newline in a folded block scalar. I fixed the list of characters that are allowed/not allowed in plain and double quoted scalars. I added the #yaml channel to the IRC link. I added links to the YAML Specs. For completeness, I also included YAML 1.2, although PyYAML and libyaml currently implement 1.1. * Improve wording * Add three more characters to forbidden first characters |
7 years ago | |
|---|---|---|
| .. | ||
| _static | 8 years ago | |
| _themes/srtd | 7 years ago | |
| js/ansible | 8 years ago | |
| man | 8 years ago | |
| rst | 7 years ago | |
| rst_common | 7 years ago | |
| .gitignore | 7 years ago | |
| .nojekyll | 8 years ago | |
| Makefile | 7 years ago | |
| Makefile.sphinx | 7 years ago | |
| README.md | 7 years ago | |
| favicon.ico | 8 years ago | |
| jinja2-2.9.7.inv | 7 years ago | |
| keyword_desc.yml | 7 years ago | |
| modules.js | 8 years ago | |
| python2-2.7.13.inv | 7 years ago | |
| python3-3.6.2.inv | 7 years ago | |
| variables.dot | 8 years ago | |
README.md
Homepage and documentation source for Ansible
This project hosts the source behind docs.ansible.com
Contributions to the documentation are welcome. To make changes, submit a pull request that changes the reStructuredText files in the "rst/" directory only, and the core team can do a docs build and push the static files.
If you wish to verify output from the markup
such as link references, you may install sphinx and build the documentation by running
make viewdocs from the ansible/docsite directory.
To include module documentation you'll need to run make webdocs at the top level of the repository. The generated
html files are in docsite/htmlout/.
To limit module documentation building to a specific module, run MODULES=NAME make webdocs instead. This should make testing module documentation syntax much
faster. Instead of a single module, you can also specify a comma-separated list
of modules. In order to skip building documentation for all modules, specify
non-existing module name, for example MODULES=none make webdocs.
If you do not want to learn the reStructuredText format, you can also file issues about documentation problems on the Ansible GitHub project.
Note that module documentation can actually be generated from a DOCUMENTATION docstring in the modules directory, so corrections to modules written as such need to be made in the module source, rather than in docsite source.
To install sphinx and the required theme, install pip and then "pip install sphinx sphinx_rtd_theme"