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

Build updates #3514

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

BrianEnigma
Copy link

The instructions in the readme for installing the dependencies to build the book seem incorrect. There is no depext target, but based on what is there, I think it's safe to assume that the Docker target is the one that lines up the build dependencies. But the Dockerfile both accumulates dependencies and builds the book, which isn't right, so I separated those into two discrete Makefile targets.

A lot of this backsolves the intent of how it should work from what's present in the project. It makes a few assumptions. Feel free to decline if this doesn't align with the actual intent of how the build should work.

The second commit adds an epub target, which was my original intent behind all this — to get a variant of the book to read on an eInk device. There's probably a better way to do this step, using Dune, but I don't yet know Dune or OCaml. Feel free to discard that second commit or refactor it to something more dune-like.

- `python-pygments` is now `python3-pygments`
- There was no `depext` Makefile target, as referenced in the README.
  Point it to the Docker target, which builds the image including
  dependencies.
- Separate building the Docker container from building the
  documentation.
- Don't copy the book source into the container. Volume mount it,
  instead. This saves having to rebuild the container when rebuilding
  the book.
- Add a Docker bash target, giving you an interactive terminal in the
  (volume-mounted) container, in case you need to manually experiment.
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.

1 participant