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

Is html_builder.move() Necessary #1386

Closed
ghost opened this issue Jun 29, 2015 · 3 comments
Closed

Is html_builder.move() Necessary #1386

ghost opened this issue Jun 29, 2015 · 3 comments
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required Needed: documentation Documentation is required

Comments

@ghost
Copy link

ghost commented Jun 29, 2015

On line 418 of tasks.py html_builder.move() is called if the HTML build is successful. That command copies the documentation from the project's old_artifact_path to artifact_path. On line 661 the files are then copied by the selected Syncer from the artifact_path to their final destination.

Is it necessary to copy files from old_artifact_path to artifact_path? Could the documentation files not be directly copied from old_artifact_path to their final destination using the appropriate Syncer?

@ericholscher
Copy link
Member

This is done so that the builder logic can contain what files are important, and not Read the Docs. The builders are self-contained, and if we moved the logic around what files they should copy into the webs, then that would break the abstraction.

@ericholscher ericholscher added Needed: design decision A core team decision is required Needed: documentation Documentation is required labels Jun 29, 2015
@ghost
Copy link
Author

ghost commented Jun 30, 2015

@ericholscher thank you for the explanation. I think I understand the necessity for the abstraction. My hope is to avoid the extra file copy operation, and, at least in my use-case, the extra clean-up step required.

Would it be bad to get a handle to each builder in move_files, and ask the build where the documentation files are? Or maybe each builder should register the built documentation path with the project model, so that it can be fetched in move_files?

@gregmuellegger gregmuellegger added the Improvement Minor improvement to code label Sep 14, 2015
@agjohnson
Copy link
Contributor

Closing this due to inactivity, seems there isn't much here to act on. Feel free to reopen if you'd like to document this or make any improvements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

3 participants