Documentation sources in the repository:
The majority of documentation is located under
Individual roles have a readme file under
os_migrate/roles/<ROLE>/README.md(Ansible Galaxy requirement).
Modules are documented directly in their Python file
Rendering the Documentation
After you make your change and before you submit a pull request, it’s good to verify that the changes you made are getting rendered into HTML correctly.
If you haven’t yet built a toolbox container for OS Migrate development, do so now:
To build the documentation, run:
./toolbox/run make docs
You can inspect the rendered documentation by opening
docs/src/_build/html/index.html in your web browser.