https://github.com/lnoor/docker-sphinx
Dockerfile to containerize the Sphinx documentation generator
https://github.com/lnoor/docker-sphinx
docker dockerfile sphinx-doc
Last synced: 4 months ago
JSON representation
Dockerfile to containerize the Sphinx documentation generator
- Host: GitHub
- URL: https://github.com/lnoor/docker-sphinx
- Owner: lnoor
- License: gpl-3.0
- Created: 2020-02-09T13:52:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T09:58:22.000Z (almost 3 years ago)
- Last Synced: 2025-02-04T15:19:18.193Z (12 months ago)
- Topics: docker, dockerfile, sphinx-doc
- Language: Dockerfile
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Dockerfile for Sphinx
This [Docker](https://www.docker.com) container offers the [Sphinx](https://sphinx-doc.org/en/master)
documentation utility. I found it cumbersome to figure out what packages to install to get Sphinx to work
on the various systems I use. Deploying this container resolves that problem.
Note that I have made no effort to keep the container as small as possible.
I wanted a container that can generate HTML, PDF and EPUB files and all necessary dependencies are included.
This container is intended to be used either stand-alone or as a basis on which Sphinx extensions can be added.
## Usage
Creating a new project::
$ docker run -u `id -u`:`id -g` --rm -ti -v `pwd`:/work lnoor/sphinx sphinx-quickstart
Build documentation::
$ docker run -u `id -u`:`id -g` --rm -ti -v `pwd`:/work lnoor/sphinx make html epub latexpdf