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

Use of rsync inside generated build.sh prevents usage with readthedocs #306

Closed
ssbarnea opened this issue Aug 20, 2024 · 3 comments · Fixed by #315
Closed

Use of rsync inside generated build.sh prevents usage with readthedocs #306

ssbarnea opened this issue Aug 20, 2024 · 3 comments · Fixed by #315
Assignees
Labels
enhancement New feature or request

Comments

@ssbarnea
Copy link
Member

ssbarnea commented Aug 20, 2024

To build with RTD, we will need to make use of custom build commands, aka build.commands feature, one that is highly promoted by them (aiming to become the default very soon).

Still, this feature comes with one major downside, losing ability to use apt_packages (and sudo is not available either).

All VM images provided by RTD do not have rsync installed and they do not want to install it.

This means that in its current form antsibull-docs cannot be integration with RTD, which is currently the most common system that allows to test pull-requests changes made to documentation.

I do think that we might need to find a way to make rsync optional in build.sh, falling back to a plain old copy instead.

References:

@ssbarnea ssbarnea added the bug Something isn't working label Aug 20, 2024
ssbarnea added a commit that referenced this issue Aug 20, 2024
@felixfontein felixfontein added enhancement New feature or request and removed bug Something isn't working labels Aug 20, 2024
@felixfontein
Copy link
Collaborator

This again is not a bug, but an enhancement.

@ssbarnea
Copy link
Member Author

@felixfontein We could argue four hours about what makes an issue a feature, bug or fug but that is better over a glass of beer. It becomes funny when a design flaw becomes a feature, just because the original design missed to cover that aspect. 🍻

@ssbarnea ssbarnea self-assigned this Aug 21, 2024
@felixfontein
Copy link
Collaborator

@ssbarnea it's pretty simple. If a feature works as designed, it's not a bug, but a feature / enhancement request. The feature here works as designed. So it's not a bug.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
2 participants