-
-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
13 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,27 @@ | ||
Readthedocs in Docker | ||
===================== | ||
# Readthedocs in Docker | ||
|
||
A Docker container of Readthedocs (RTD). | ||
|
||
Usage | ||
----- | ||
## Usage | ||
|
||
Run as a daemon : | ||
Run using docker-compose: | ||
|
||
docker run -d -p 8000:8000 moul/readthedocs | ||
* start a readthedocs container + its dependencies (postgresql, elasticsearch and redis) | ||
|
||
Run in foreground : | ||
```console | ||
$ docker-compose run --service-ports --rm readthedocs | ||
# or | ||
$ make run | ||
``` | ||
|
||
docker run -it -p 8000:8000 moul/readthedocs | ||
--- | ||
|
||
Run in debug mode (bash) : | ||
|
||
make run | ||
# or | ||
docker run -it --rm --entrypoint=bash moul/readthedocs | ||
|
||
Build the container from sources : | ||
|
||
docker build -t moul/readthedocs . | ||
# or | ||
make build | ||
## License | ||
|
||
MIT |