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/docs/docsite
John R Barker 3afb67e9b2 Fix Docs build issues (#22295)
* restore network docs fragments

* Fix RST errors

* code-block formatting
8 years ago
..
_static consolidated docs 8 years ago
_themes/srtd Bumping docs footer copyright year (#22210) 8 years ago
js/ansible consolidated docs 8 years ago
man consolidated docs 8 years ago
rst Fix Docs build issues (#22295) 8 years ago
rst_common consolidated docs 8 years ago
.gitignore consolidated docs 8 years ago
.nojekyll consolidated docs 8 years ago
Makefile leaving os immediate 8 years ago
Makefile.sphinx Use correct path for docsite src (rst/) 8 years ago
README.md consolidated docs 8 years ago
conf.py PEP 8 indent cleanup. (#20800) 8 years ago
favicon.ico consolidated docs 8 years ago
modules.js consolidated docs 8 years ago
variables.dot consolidated docs 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/.

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"