ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-10-22 12:03:58 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Remove extra "latest/" subdirectory in docs build structure.

Browse source
This commit is contained in:
Michael DeHaan 2013-10-14 08:27:30 -04:00
commit 0cd09dd54f
79 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docsite/README.md Normal file
View file

@ -0,0 +1,29 @@
Homepage and documentation source for Ansible
=============================================
This project hosts the source behind [ansibleworks.com/docs](http://www.ansibleworks.com/docs/)
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/latest` directory.
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][module-docs]
in the modules directory, so corrections to modules written as such need to be made
in the module source, rather than in docsite source.
Author
======
Michael DeHaan -- michael.dehaan@gmail.com
[http://michaeldehaan.net](http://michaeldehaan.net/)
[install Sphinx]: http://sphinx-doc.org/install.html
[file issues]: https://github.com/ansible/ansible/issues
[module-docs]: http://www.ansibleworks.com/docs/moduledev.html#documenting-your-module