configure sphinx-init to use devel docs #391
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
sphinx-init
currently still points to Ansible 4 docs for references that don't resolve in the current doc set.We could point it at 5, and then update it as new ansible versions are released, but in my opinion the
devel
docs are the better ones to point to since what you're building with this process is probably going to be newer docs, pointing to the newest stuff.@felixfontein recommended falling back to another version. Initially I agreed that was a good idea, but as I think about it more, I wonder if in the end it would cause references that are no longer valid in the latest docs to unexpectedly resolve to a previous version in the docs, hiding the error.
So I've included the fallback in this PR, but I think I'm leading toward removing it and using
devel
exclusively; open to discussion and thoughts as I'm not terribly knowledgeable on this stuff.