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 --intersphinx option to sphinx-init subcommand #44

Merged
merged 2 commits into from
Oct 3, 2022

Conversation

felixfontein
Copy link
Collaborator

Fixes #35.

@tremble
Copy link

tremble commented Sep 28, 2022

Just tested this locally using:

antsibull-docs sphinx-init --use-current amazon.aws --dest-dir /tmp/docs/amazon.aws/ --intersphinx ansible_devel:https://docs.ansible.com/ansible-core/devel/ --intersphinx community_aws:https://ansible-collections.github.io/community.aws/branch/main/

and

antsibull-docs sphinx-init --use-current community.aws --dest-dir /tmp/docs/community.aws/ --intersphinx ansible_devel:https://docs.ansible.com/ansible-core/devel/ --intersphinx amazon_aws:https://ansible-collections.github.io/amazon.aws/branch/main/

Worked as expected and resulted in the relevant cross-documentation links being generated (deliberate choice to override ansible_devel with the ansible-core docs as this forces amazon.aws/community.aws docs to reference the collection docs rather than possibly pulling links from modules docs in the "ansible" distribution)

@felixfontein felixfontein changed the title [WIP] Add --intersphinx option to sphinx-init subcommand Add --intersphinx option to sphinx-init subcommand Sep 28, 2022
@felixfontein felixfontein merged commit 1a8a47d into ansible-community:main Oct 3, 2022
@felixfontein felixfontein deleted the intersphinx branch October 3, 2022 19:11
@felixfontein
Copy link
Collaborator Author

@tremble @samccann thanks for reviewing and testing!

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.

[RFE] Add support for adding additional sphinx/intersphinx configuration
3 participants