https://github.com/nickjer/docker-sphinx
Sphinx documentation builder with extras in a Docker container
https://github.com/nickjer/docker-sphinx
Last synced: over 1 year ago
JSON representation
Sphinx documentation builder with extras in a Docker container
- Host: GitHub
- URL: https://github.com/nickjer/docker-sphinx
- Owner: nickjer
- License: mit
- Created: 2017-03-11T02:30:18.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-04-19T13:32:51.000Z (about 8 years ago)
- Last Synced: 2025-01-13T20:14:32.199Z (over 1 year ago)
- Homepage:
- Size: 7.81 KB
- Stars: 4
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Docker Sphinx
[](https://travis-ci.org/nickjer/docker-sphinx)
[](https://hub.docker.com/r/nickjer/docker-sphinx/)
[](https://opensource.org/licenses/MIT)
Docker image for [Sphinx](http://www.sphinx-doc.org/en/stable/).
This image contains:
- [Sphinx](http://www.sphinx-doc.org/en/stable/)
- A variety of themes:
- [Alabaster](http://alabaster.readthedocs.io/en/latest/)
- [Sphinx Bootstrap Theme](http://ryan-roemer.github.io/sphinx-bootstrap-theme/README.html)
- [sphinx_rtd_theme](https://github.com/rtfd/sphinx_rtd_theme)
- A markdown parser for reStructuredText ([recommonmark](https://github.com/rtfd/recommonmark))
- A sphinx watcher tool ([sphinx-autobuild](https://github.com/GaretJax/sphinx-autobuild/))
- A variety of plugins:
- [sphinx-prompt](https://github.com/sbrunner/sphinx-prompt)
- [sphinxcontrib-actdiag](https://pypi.python.org/pypi/sphinxcontrib-actdiag)
- [sphinxcontrib-blockdiag](https://pypi.python.org/pypi/sphinxcontrib-blockdiag)
- [sphinxcontrib-nwdiag](https://pypi.python.org/pypi/sphinxcontrib-nwdiag)
- [sphinxcontrib-seqdiag](https://pypi.python.org/pypi/sphinxcontrib-seqdiag)
- [sphinxcontrib-plantuml](https://pypi.python.org/pypi/sphinxcontrib-plantuml)
- [sphinxcontrib-exceltable](https://pypi.python.org/pypi/sphinxcontrib-exceltable)
- [sphinxcontrib-googleanalytics](https://pypi.python.org/pypi/sphinxcontrib-googleanalytics)
- [sphinxcontrib-googlechart](https://pypi.python.org/pypi/sphinxcontrib-googlechart)
- [sphinxcontrib-googlemaps](https://pypi.python.org/pypi/sphinxcontrib-googlemaps)
- [sphinxcontrib-httpdomain](https://pypi.python.org/pypi/sphinxcontrib-httpdomain)
- Latex to generate PDF documents
## Build
```sh
git clone https://github.com/nickjer/docker-sphinx.git
cd docker-sphinx
docker build --force-rm -t nickjer/docker-sphinx .
```
## Install
```sh
docker pull nickjer/docker-sphinx
```
## Usage
```sh
docker run --rm -i -t -v "${PWD}:/doc" -u "$(id -u):$(id -g)" nickjer/docker-sphinx
```
### Docker Compose
It is recommended to use [Docker Compose](https://docs.docker.com/compose/). An
example `docker-compose.yml` is seen as:
```yaml
version: "2"
services:
sphinx:
image: "nickjer/docker-sphinx"
volumes:
- "${PWD}:/doc"
user: "1000:1000"
```
Then run:
```sh
docker-compose run --rm sphinx
```
Examples:
```sh
docker-compose run --rm sphinx sphinx-quickstart
docker-compose run --rm sphinx make html
```