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/docs/docsite
Wolfgang Felbermeier 496ce388ab documentation: render nested return dicts for more then one level (#33143)
* Render nested return value documentation for more then one level
in the generated webdocs.

* Remove unnecessary code and cleanup

* Implement recursive option documentation

* Build elbow intendation style for options and return documentation
2017-11-22 16:53:53 -05:00
..
_static consolidated docs 2017-01-06 09:16:59 -05:00
_themes/srtd documentation: render nested return dicts for more then one level (#33143) 2017-11-22 16:53:53 -05: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 Add changes to succeeded/failed tests to the 2.4 porting guide (#33201) 2017-11-22 16:14:31 -05: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 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 Keywords docs (#32807) 2017-11-10 16:59:26 -08:00
Makefile more updates to plugin/config generation (#30787) 2017-10-11 00:15:25 -04:00
Makefile.sphinx Generate plugin rst (#28901) 2017-09-19 11:14:27 -04: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"