Skip to content

Conversation

Thoughtscript
Copy link
Contributor

@Thoughtscript Thoughtscript commented Jun 29, 2025

Hello! I've gone ahead and Dockerized the repo. I've also addressed issues, suggestions, and concerns raised here: #2379 (and made a new PR - apologies, I thought this might get a bit more involved but the solution ended up being a bit more elegant/made some typos/excessive errata's in the last "draft").


📚 Documentation preview 📚: https://writethedocs-www--2392.org.readthedocs.build/

A barebones [dockerfile](./dockerfile) is supplied to run the site within a local Docker Container through [Docker Desktop](https://docs.docker.com/desktop/) - a simple, free, way to easily setup Docker and Python without leaving beyond installations, modifying your underlying Operating System, and changing Environment Variables.

1. Make sure Docker Desktop is running and started
1. Build the Docker Image from the root directory with the command: `docker build -t wtd .`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@plaindocs - I tweaked the recommended build per your prior comment here: #2379 (comment) - loved that suggestion - thanks!


RUN chmod +x make.bat

# The following CMD is run every time the Container starts
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This actually took a bit - thought I could simply copy over my prior BASH script but it seems I need to/should reset the WORKDIR to use CMD (over ENTRYPOINT) for a slightly more succinct command.

sphinx-autobuild --port 8888 -j auto --watch _data -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/html

# Used solely to bind sphinx to the Docker Container - to do so requires deliberately setting --host "0.0.0.0"
dockerhtml:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added comments per request.

Copy link
Contributor

@plaindocs plaindocs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@plaindocs
Copy link
Contributor

Thanks for the fixes

@plaindocs plaindocs merged commit ffb7038 into writethedocs:main Jun 29, 2025
7 checks passed
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.

2 participants