New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve readthedocs config #8

Open

oraNod opened this issue Aug 29, 2024 · 1 comment

Contributor

oraNod commented Aug 29, 2024 •

edited

Loading

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

Contributor Author

oraNod commented Sep 3, 2024

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/

oraNod changed the title ~~Set up the docsite on RTD~~ Improve readthedocs config

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment