1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/docsite
John Dewey 44b0ee5322 Can override each role's install path
Defaults to the system wide `roles-path` when `path` is not specified in the
provided `role-file`.  An example installing nginx to a relative path specified
by the `role-file`.

    - src: https://github.com/bennojoy/nginx
      path: vagrant/roles/
2014-08-27 16:43:39 -07:00
..
_static multiple spelling error changes 2014-04-29 10:41:05 -04:00
_themes/srtd Fix fonts in docs: Incosolata -> Inconsolata 2014-08-15 10:21:41 +02:00
js/ansible Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
man Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
rst Can override each role's install path 2014-08-27 16:43:39 -07:00
.gitignore Add *.min.css to docsite/.gitignore 2014-01-06 17:15:04 -06:00
.nojekyll Subtree merge of ansible-docs 2012-10-08 07:44:38 -04:00
build-site.py Fix path to index.html when launching browser 2014-02-17 12:00:41 +01:00
conf.py AnsibleWorks -> Ansible 2014-01-28 20:29:42 -05:00
favicon.ico Retinafy favicon.ico 2014-05-12 11:29:45 -04:00
Makefile Add the start of a graphviz doc to illustrate variable precedence graphically. 2014-05-09 17:13:01 -04:00
modules.js Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
README.md AnsibleWorks -> Ansible 2014-01-28 20:29:42 -05:00
variables.dot Add the start of a graphviz doc to illustrate variable precedence graphically. 2014-05-09 17:13:01 -04: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 Michael 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"