ansible/docs/docsite
Abhijeet Kasurde 8f6626bd8f Misc typo corrections
Fix adds correction for typos

* Anisble to Ansible
* Fasle to False

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2017-09-09 10:25:50 -07:00
..
_static consolidated docs 2017-01-06 09:16:59 -05:00
_themes/srtd minor fixes to docsite root URLs (#28945) 2017-09-01 16:48:53 -07:00
js/ansible consolidated docs 2017-01-06 09:16:59 -05:00
man consolidated docs 2017-01-06 09:16:59 -05:00
rst Misc typo corrections 2017-09-09 10:25:50 -07:00
rst_common consolidated docs 2017-01-06 09:16:59 -05:00
.gitignore Initial ansible-test sanity docs. (#26775) 2017-07-14 14:24:45 +01:00
.nojekyll consolidated docs 2017-01-06 09:16:59 -05:00
favicon.ico consolidated docs 2017-01-06 09:16:59 -05:00
jinja2-2.9.7.inv Update the intersphinx cached indexes 2017-08-14 08:15:28 -07:00
keyword_desc.yml change generated playbooks_keywords.rst to use an rst 'glossary' (#28843) 2017-09-07 15:46:53 -04:00
Makefile generate rst doc pages for command line tools (#27530) 2017-09-07 15:44:20 -04:00
Makefile.sphinx Use correct path for docsite src (rst/) 2017-01-13 18:14:33 -05:00
modules.js consolidated docs 2017-01-06 09:16:59 -05:00
python2-2.7.13.inv Update the intersphinx cached indexes 2017-08-14 08:15:28 -07:00
python3-3.6.2.inv Update the intersphinx cached indexes 2017-08-14 08:15:28 -07:00
README.md Implement ability to limit module documentation building (#24576) 2017-08-04 13:10:36 -07:00
variables.dot consolidated docs 2017-01-06 09:16:59 -05:00

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"