ansible/docs/docsite
Dylan Silva 6f4f7011f1 Updates to docs for developers (#24034)
- Added items to index for TOC
- Changed some formatting on overview_architecture
- removed some out of date items from developing_modules_general
2017-05-08 09:08:55 -07:00
..
_static
_themes/srtd Switch Adobe tracking off staging. 2017-04-17 13:36:31 -07:00
js/ansible
man
rst Updates to docs for developers (#24034) 2017-05-08 09:08:55 -07:00
rst_common
.gitignore
.nojekyll
favicon.ico
jinja2-2.9.6.inv Enable intersphinx for python stdlib and jinja2 2017-04-25 12:26:40 -07:00
keyword_desc.yml moved docs generation and templates to docs/ 2017-03-24 15:52:36 -04:00
Makefile added epub entry for makefile 2017-05-01 13:41:04 -04:00
Makefile.sphinx Use correct path for docsite src (rst/) 2017-01-13 18:14:33 -05:00
modules.js
python2-2.7.13.inv Enable intersphinx for python stdlib and jinja2 2017-04-25 12:26:40 -07:00
python3-3.6.1.inv Enable intersphinx for python stdlib and jinja2 2017-04-25 12:26:40 -07:00
README.md
variables.dot

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"