-
Notifications
You must be signed in to change notification settings - Fork 654
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
Refactor building docs #858
Conversation
bea3777
to
ad30e9f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am inclined to support an approach where we first remove the in-repo-theme and replace it with sphinx-ansible-theme via #856
We can refactor the docs layout after we do this. My experiement worked really fine and proved that RTD can build our docs nicely. Take a look at mentioned PR.
Current sphinx-ansible-theme does not add any customizations yet, but this is what I am going to do now, mainly taking current Ansible theme into it.
@ssbarnea I agree that we need to get the theme out of the repo but, as I see it, it's easier to go it step-by-step with small incremental changes like this one. |
@webknjaz I am ok with the incremental approach but there is one critical issue: the RTD build is broken and this build also breaks the zuul publishing due to changed path, practically making impossible to review the outcome of the change. If RTD would render fine, I would merge it right now. |
I think you could change Zuul config to improve this. Right now I don't want to overwhelm it with too many changes. |
1d1e799
to
a864ac9
Compare
@ssbarnea here I've adjusted the var to point to the changed location ansible/ansible-zuul-jobs#576 |
a93f7a0
to
eec471a
Compare
eec471a
to
1ccf634
Compare
Co-Authored-By: Sorin Sbarnea <ssbarnea@redhat.com>
ce29199
to
a06b0fb
Compare
This change is only a first (small) step towards making the docs setup better.
Everything else is kept out intentionally: small changes are easier to reason about and accepting them fast allows us to minimize conflicts with related changes.