https://github.com/jkawamoto/docker-sphinx-make

A docker container for Sphinx.
https://github.com/jkawamoto/docker-sphinx-make

Last synced: 13 days ago
JSON representation

A docker container for Sphinx.

• Host: GitHub
• URL: https://github.com/jkawamoto/docker-sphinx-make
• Owner: jkawamoto
• License: mit
• Created: 2015-06-22T07:14:59.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-06-29T12:44:47.000Z (over 9 years ago)
• Last Synced: 2024-04-11T15:27:09.619Z (7 months ago)
• Language: Python
• Size: 129 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
A docker container for Sphinx

==============================

This docker image contains `make` command for Sphinx. When your Sphinx source codes are in `/data`, you may compile them and obtain html documents with a docker container.

```sh

$ docker run --rm -v /data:/data jkawamoto/sphinx-make --cwd /data

```

If you also need LaTeX documents, you can obtain it, too.

```sh

$ docker run --rm -v /data:/data jkawamoto/sphinx-make --cwd /data latex

```

Arguments

------------

The container has the following arguments.

```

docker run jkawamoto/sphinx-make [--cwd CWD] [params [params ...]]

positional arguments:

  params      specify options of make (default: html).

optional arguments:

  -h, --help  show this help message and exit

  --cwd CWD   specify a directory containing Makefile.

```

License

--------

This software is released under the MIT License, see LICENSE.