ansible/docs/docsite
scottb f8f34c7bab
Moved generated module RSTs to their own directory. (#33966)
* Moved generated module RSTs to their own directory.

* WIP commit - fixed conflict with conf.py exclude_patterns by renaming module RST output directory to 'module_docs'.

* Added new directory to formatter module links; aded new module directory to makefile clean.

* Removed illegal comment from block.
2017-12-21 01:47:39 -08:00
..
_static
_themes/srtd Fix css of elbow indentation for firefox (#33225) 2017-11-27 13:13:17 +10:00
js/ansible
man
rst Moved generated module RSTs to their own directory. (#33966) 2017-12-21 01:47:39 -08:00
rst_common Add a code-smell test for smart quotes and remove smart quotes from all files 2017-09-18 16:49:16 -07:00
.gitignore Initial ansible-test sanity docs. (#26775) 2017-07-14 14:24:45 +01:00
.nojekyll
favicon.ico
jinja2-2.9.7.inv Update the intersphinx cached indexes 2017-08-14 08:15:28 -07:00
keyword_desc.yml Keywords docs (#32807) 2017-11-10 16:59:26 -08:00
Makefile Moved generated module RSTs to their own directory. (#33966) 2017-12-21 01:47:39 -08:00
Makefile.sphinx Generate plugin rst (#28901) 2017-09-19 11:14:27 -04:00
modules.js
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

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"