You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docs/docsite
Matt Martz 86e4619dcf
Update echo ansible-vault example with -n as without this, you get a newline. Fixes #34795 (#34823)
7 years ago
..
_static consolidated docs 8 years ago
_themes/srtd remove erroneous '.' in docsite footer (#34592) 7 years ago
js/ansible consolidated docs 8 years ago
man consolidated docs 8 years ago
rst Update echo ansible-vault example with -n as without this, you get a newline. Fixes #34795 (#34823) 7 years ago
rst_common Add a code-smell test for smart quotes and remove smart quotes from all files 7 years ago
.gitignore Initial ansible-test sanity docs. (#26775) 7 years ago
.nojekyll consolidated docs 8 years ago
Makefile Moved generated module RSTs to their own directory. (#33966) 7 years ago
Makefile.sphinx Generate plugin rst (#28901) 7 years ago
README.md Implement ability to limit module documentation building (#24576) 7 years ago
favicon.ico consolidated docs 8 years ago
jinja2-2.9.7.inv Update the intersphinx cached indexes 7 years ago
keyword_desc.yml Keywords docs (#32807) 7 years ago
modules.js consolidated docs 8 years ago
python2-2.7.13.inv Update the intersphinx cached indexes 7 years ago
python3-3.6.2.inv Update the intersphinx cached indexes 7 years ago
variables.dot consolidated docs 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"