f2fed10ad8
* first round of splitting and expanding Windows docs * Added info about WinRM and started the usage page * more details onf usage around command/shell * added more info * missed a page * added info about hotfix and ps upgrade script * Added DSC information * filled in FAQ and fixed up links * changes per PR review and typo fixes found by myself * fixed sanity check * updated external script URLS * Edits * Edits * Edits * Copy edits. * More copy edits. * Added info about becoming a local service account * some formatting changes on become and DSC indent fix * Copy edits/rewrites * Copy edits/rewrites * minor updates to UAC text, typos * minor wording updates * minor wording tweaks/typos * minor wording tweaks/typos * minor tweaks/typos * fix indent issue * fix title underline length * fix quote issue |
7 years ago | |
|---|---|---|
| .. | ||
| _static | 8 years ago | |
| _themes/srtd | 7 years ago | |
| js/ansible | 8 years ago | |
| man | 8 years ago | |
| rst | 7 years ago | |
| rst_common | 7 years ago | |
| .gitignore | 7 years ago | |
| .nojekyll | 8 years ago | |
| Makefile | 7 years ago | |
| Makefile.sphinx | 7 years ago | |
| README.md | 7 years ago | |
| favicon.ico | 8 years ago | |
| jinja2-2.9.7.inv | 7 years ago | |
| keyword_desc.yml | 7 years ago | |
| modules.js | 8 years ago | |
| python2-2.7.13.inv | 7 years ago | |
| python3-3.6.2.inv | 7 years ago | |
| variables.dot | 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"