Add Docker and docker-compose support for documentation development (#176)#267
Open
ParthMozarkar wants to merge 2 commits intoaboutcode-org:mainfrom
Open
Add Docker and docker-compose support for documentation development (#176)#267ParthMozarkar wants to merge 2 commits intoaboutcode-org:mainfrom
ParthMozarkar wants to merge 2 commits intoaboutcode-org:mainfrom
Conversation
Signed-off-by: Parth Mozarkar <greatparth21@gmail.com>
Signed-off-by: Parth Mozarkar <greatparth21@gmail.com>
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
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.
Overview
This PR introduces containerization support to simplify the development and documentation build process.
By providing a standardized Docker environment, contributors can build and serve the documentation without installing project-specific dependencies locally.
Changes
Added a Dockerfile based on python:3.10-slim to standardize the documentation build environment.
Added a docker-compose.yml configuration to easily spin up the documentation server with live reloading support.
Configured the container to run the documentation server with appropriate port exposure for local development.
Benefits
Eliminates “works on my machine” issues by ensuring a consistent development environment.
Simplifies onboarding for new contributors — running docker-compose up is sufficient to start the documentation server.
Reduces dependency setup friction.
Provides a foundation for future CI/CD or deployment pipelines.
Usage
docker-compose up
Then open the browser at:
http://localhost:8000
Closes
Closes #176