internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-08 06:12:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add README info for building the module documentation.

Browse Source
This commit is contained in:
Jinn Koriech
2013-12-05 17:01:49 +00:00
parent 6f2843724d
commit 80d6ca19af
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docsite/README.md
View File

@@ -7,7 +7,10 @@ Contributions to the documentation are welcome. To make changes, submit a pull
that changes the reStructuredText files in the "rst/" directory only, and Michael can 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 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 such as link references, you may [install Sphinx] and build the documentation by running
`make viewdocs` from the `ansible/docsite` directory. `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/ and will require Wordpress to render correctly.
If you do not want to learn the reStructuredText format, you can also [file issues] about If you do not want to learn the reStructuredText format, you can also [file issues] about
documentation problems on the Ansible GitHub project. documentation problems on the Ansible GitHub project.