refactor(makefile): sphinx-build make mode #585
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Refactor this to reduce some redundant logic, simplify and describe variable blocks, and use the sphinx-build make mode. Newer versions of sphinx-quickstart have started rolling out make mode. This provides a useful help note and allows users to try multiple builders very easily. I believe we should redirect most targets through this new mode. Unfortunately this mode appends the builder name to the output path. Given that our current software-dl.ti.com deployment scheme relies on a specific output path, I've added a "ti" target to provide the older behavior and made it the default. The normal "html" builder will use the standard sphinx-build output scheme with only one directory corresponding to the platform and os values. The version will be assumed to be unnecessary in this mode. Signed-off-by: Randolph Sapp <rs@ti.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Refactor this to reduce some redundant logic, simplify and describe variable blocks, and use the sphinx-build make mode.
Newer versions of sphinx-quickstart have started rolling out make mode. This provides a useful help note and allows users to try multiple builders very easily. I believe we should redirect most targets through this new mode.
Unfortunately this mode appends the builder name to the output path. Given that our current software-dl.ti.com deployment scheme relies on a specific output path, I've added a "ti" target to provide the older behavior and made it the default.
The normal "html" builder will use the standard sphinx-build output scheme with only one directory corresponding to the platform and os values. The version will be assumed to be unnecessary in this mode.