-
Notifications
You must be signed in to change notification settings - Fork 11
Add entrypoint to build the docs and serve them over http #2
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
base: master
Are you sure you want to change the base?
Conversation
@tacaswell @QuLogic If this is still of interest to be able to build the docs in this Docker image I can have the CI system that I showed in the SciPy sprints Slack chat do this and then deploy the built docs to wherever.
The |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we make this the ENTRYPOINT
? I'm not sure what our overall aim is for the container, tbh...
Co-authored-by: Elliott Sales de Andrade <[email protected]>
Co-authored-by: Elliott Sales de Andrade <[email protected]>
Thanks for the enhancement suggestions, @QuLogic! I accepted them. Would be great to have a proper Docker Entrypoint. Something like https://github.com/conda-forge/docker-images/blob/fe1a5326926fd75bb90bfa7bfe9e39e6509ab9f1/linux-anvil-comp7/Dockerfile#L49-L58? |
It is still a bit unclear to me what the intended use case of the Docker image is, but even if the purpose is only "build the docs" it seems like using the |
Indeed, valid points. Maybe the originally suggested flexibility with the bash command is sufficient. |
To be used as:
$ docker run -it --rm -p 8000:8000 -v $PWD:/tmp/bin/ mrakitin/mpl-docker:latest bash /tmp/bin/entrypoint.sh
Cloning of the MPL repo may take a long time, but once it's done, it will install the package in the dev-mode, will build the docs and will start serving them from the
docs/build/html/
directory.Access on the host machine: http://localhost:8000
A note to myself: this
entrypoint.sh
script should be made a part of the Docker image, so can be executed without mounting.attn @tacaswell