https://github.com/bwibo/sphinx-rtd-docker
Dockerfile for compiling Sphinx with ReadTheDocs
https://github.com/bwibo/sphinx-rtd-docker
dockerfile readthedocs rtd sphinx sphinx-copybutton sphinx-emoji sphinx-extension
Last synced: 6 months ago
JSON representation
Dockerfile for compiling Sphinx with ReadTheDocs
- Host: GitHub
- URL: https://github.com/bwibo/sphinx-rtd-docker
- Owner: BWibo
- Created: 2021-02-16T10:47:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-30T06:59:11.000Z (over 2 years ago)
- Last Synced: 2025-02-15T23:25:44.501Z (8 months ago)
- Topics: dockerfile, readthedocs, rtd, sphinx, sphinx-copybutton, sphinx-emoji, sphinx-extension
- Language: Shell
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docker image for Sphinx and ReadTheDocs
`Dockerfile` for [Sphinx](https://www.sphinx-doc.org/en/master/) including following extensions:
* Sphinx ReadTheDocs Theme: [`sphinx_rtd_theme`](https://github.com/readthedocs/sphinx_rtd_theme)
* Copy burron [`sphinx_copybutton`](https://github.com/executablebooks/sphinx-copybutton)
* Sphinx emojies [`sphinxemoji`](https://github.com/sphinx-contrib/emojicodes)
* Sphinx Fontwaesome [`sphinx_fontawesome`](https://pypi.org/project/sphinx_fontawesome/)
* Sphinx Toolbox [`sphinx-toolbox`]([sphinx-toolbox](https://pypi.org/project/sphinx-toolbox))
The image is available on DockerHub: https://hub.docker.com/repository/docker/bwibo/sphinx-rtd
## Usage
Mount your local `docs` folder to `/docs` inside the container and append the command you want to use.
More info on the available commands is available in the documentation of the base image:
https://hub.docker.com/r/sphinxdoc/sphinx
```bash
# Build HTML docs
docker run --rm \
-v $PWD:/docs \
bwibo/sphinx-rtd make html
```
## Build
Run `build.sh` to build the image or:
```bash
docker build -t bwibo/sphinx-rtd --build-arg SPHINX_VERSION=6.2.1 .
```