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

configure sphinx-init to use devel docs #391

Merged

Conversation

briantist
Copy link
Contributor

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.

Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I now tend to agree that not referencing a fixed version is good. I would keep a comment which shows how to reference a specific version, but not mention one by default.

src/antsibull/data/sphinx_init/conf_py.j2 Outdated Show resolved Hide resolved
Co-authored-by: Felix Fontein <felix@fontein.de>
@felixfontein felixfontein merged commit cbff837 into ansible-community:main Jan 26, 2022
@felixfontein
Copy link
Collaborator

@briantist thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants