search

ansible-community / awx-operator-helm

Helm chart for the AWX operator.
https://ansible-community.github.io/awx-operator-helm/
GNU General Public License v3.0
28 stars 8 forks source link

Improve readthedocs config #8

Open oraNod opened 2 months ago

oraNod commented 2 months ago

There is a basic docsite and readthedocs config in this repo. There's also a noxfile that includes a build session.

The current readthedocs (rtd) config uses the default mkdocs configuration. It would be preferable to use the nox session instead because it runs in strict mode. This means the same environment in ci, rtd, and local user builds. Here is an example of how we can use the nox session in the rtd config: https://github.com/ansible/docsite/blob/603f2baa6c76f8651e2fdfb0e9b8a696d37843f0/.readthedocs.yaml#L11

oraNod commented 2 months ago

I've gone ahead and imported the project into readthedocs and added it to the ansible namespace. The docsite is available at https://ansible.readthedocs.io/projects/awx-operator-helm/