Skip to content
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.

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

Add readthedocs configuration #14413

Merged
merged 3 commits into from
Sep 5, 2023
Merged

Add readthedocs configuration #14413

merged 3 commits into from
Sep 5, 2023

Conversation

oraNod
Copy link
Collaborator

@oraNod oraNod commented Sep 5, 2023

SUMMARY

This PR adds Read The Docs configuration to host the content generated from docs/docsite/rst.

ISSUE TYPE
  • Bug, Docs Fix or other nominal change
COMPONENT NAME
  • Docs
AWX VERSION

N/A

ADDITIONAL INFORMATION

N/A

@oraNod
Copy link
Collaborator Author

oraNod commented Sep 5, 2023

@AlanCoding Please take a look whenever you're ready.

A future improvement could be to add positional args to the tox command so we can pass something like python3 -m tox -e docs -- --strict --site-dir=_readthedocs/html/ instead of using the mkdir and mv commands. However I would prefer to do that as a follow on PR.

@AlanCoding
Copy link
Member

might be good to add "_readthedocs" to the .gitignore file

Also, linter wants

./.readthedocs.yaml
  4:1       warning  missing document start "---"  (document-start)

because it's a yaml file, it's checked by yamllint. If that might cause trouble there is an ignore list somewhere.

@AlanCoding
Copy link
Member

I edited the ISSUE TYPE because our checks look for highly specific syntax with that.

@tvo318 tvo318 merged commit 5733f78 into ansible:devel Sep 5, 2023
14 of 15 checks passed
djyasin pushed a commit to djyasin/awx that referenced this pull request Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants