build: add Dockerfile for local build environment #532
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
- Added a Dockerfile to simplify the setup process for building the reference manual locally. - Updated the README with instructions for building and running the manual using Docker.
|
I'm a bit nervous about adding a new build method that's not part of CI and that I myself don't regularly use. Users may come to depend on it, which is not great if it bit-rots. What's the main benefit of Docker here? If it's just making the TeX parts easier, then I plan to just check in the figures along with their source. Does this make it easier to build it and check the examples on Windows? |
|
(and sorry for the slow response, this PR arrived just as I left on summer vacation) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added Docker Support for Building the Reference Manual
This pull request introduces the following changes:
Motivation
These changes aim to make it easier for contributors and users to build the reference manual without needing to install dependencies manually. Docker provides a consistent and isolated environment for building the project.
Changes
Related Issue
This pull request is not associated with any existing issue.