https://github.com/sphinx-doc/sphinx-docker-images
Container images for Sphinx
https://github.com/sphinx-doc/sphinx-docker-images
Last synced: 11 months ago
JSON representation
Container images for Sphinx
- Host: GitHub
- URL: https://github.com/sphinx-doc/sphinx-docker-images
- Owner: sphinx-doc
- Created: 2020-02-23T08:49:45.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-01T17:26:39.000Z (11 months ago)
- Last Synced: 2025-03-01T18:29:37.866Z (11 months ago)
- Language: Dockerfile
- Homepage:
- Size: 93.8 KB
- Stars: 51
- Watchers: 14
- Forks: 33
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
=========================
Docker Images for Sphinx_
=========================
Images
======
- ``sphinx`` --
Main Sphinx image --
`Docker Hub `__,
`GitHub Container Registry `__
- ``sphinx-latexpdf`` --
Image for LaTeX --
`Docker Hub `__,
`GitHub Container Registry `__
.. note:: The ``sphinx-latexpdf`` container contains TeXLive images,
meaning it is very large (over 2GiB).
Usage
=====
Create a Sphinx project:
.. code:: bash
$ docker run -it --rm -v /path/to/document:/docs sphinxdoc/sphinx sphinx-quickstart
Build HTML document:
.. code:: bash
$ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx sphinx-build -M html . _build
Build EPUB document:
.. code:: bash
$ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx sphinx-build -M epub . _build
Build PDF document:
.. code:: bash
$ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx-latexpdf sphinx-build -M latexpdf . _build
Tips
====
To install additional dependencies, use ``sphinxdoc/sphinx`` as a base image:
.. code:: dockerfile
# in your Dockerfile
FROM sphinxdoc/sphinx
WORKDIR /docs
ADD requirements.txt /docs
RUN python3 -m pip install -r requirements.txt
Sphinx CI Docker Image
======================
The Docker image used for testing Sphinx_ in continuous integration is defined
in the ``ci`` directory.
.. _Sphinx: http://www.sphinx-doc.org/