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/docsite
Adam Hartz cebf127d68 Change reference to basic.py, where the implementation details live 9 years ago
..
_static multiple spelling error changes 11 years ago
_themes/srtd adding swiftype search script to footer.html 9 years ago
js/ansible Remove extra "latest/" subdirectory in docs build structure. 11 years ago
man Remove extra "latest/" subdirectory in docs build structure. 11 years ago
rst Change reference to basic.py, where the implementation details live 9 years ago
.gitignore Add *.min.css to docsite/.gitignore 11 years ago
.nojekyll Subtree merge of ansible-docs 12 years ago
Makefile add webdocs as alias 9 years ago
README.md Update README.md 9 years ago
build-site.py Make "make webdocs" compatible with Python 3 9 years ago
conf.py enabled yaml highlighting globally, made specific emphasis for blocks in playbooks_blocks docs 9 years ago
favicon.ico Retinafy favicon.ico 11 years ago
modules.js Remove extra "latest/" subdirectory in docs build structure. 11 years ago
variables.dot Add the start of a graphviz doc to illustrate variable precedence graphically. 11 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/.

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"