diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-14 20:04:50 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-14 20:04:50 +0000 |
| commit | 782f8df6e41f29dce2db4970a3ad84aaeb7d8c5f (patch) | |
| tree | 3a88a542cd8074743d251881131510157cfc510b /docs/README.md | |
| parent | Initial commit. (diff) | |
| download | ansible-lint-50bdc147c85841d355d060ea2f4ecfaa682bc192.tar.xz ansible-lint-50bdc147c85841d355d060ea2f4ecfaa682bc192.zip | |
Adding upstream version 4.3.7.upstream/4.3.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..b84f668 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,9 @@ +# Documentation source for Ansible Lint + +To build the docs, run `tox -e docs`. At the end of the build, you will +see the local location of your built docs. + +Building docs locally may not be identical to CI/CD builds. We recommend +you to create a draft PR and check the RTD PR preview page too. + +If you do not want to learn the reStructuredText format, you can also [file an issue](https://github.com/ansible/ansible-lint/issues), and let us know how we can improve our documentation. |