Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sonodar/docker-sphinx-build
https://github.com/sonodar/docker-sphinx-build
Last synced: 28 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sonodar/docker-sphinx-build
- Owner: sonodar
- Created: 2015-09-03T09:29:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-01T07:36:56.000Z (about 8 years ago)
- Last Synced: 2024-10-25T10:40:05.692Z (3 months ago)
- Language: Python
- Size: 14.6 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
============
What's this?
============
Sphinx documents builder on docker container.
============
Requirements
============
docker 1.7+
==========
How to use
==========
*************************
Create new sphinx project
*************************
::
sphinx-quickstart ./sphinx-docs
************************
Or get from repositories
************************
::
git clone your_repository_path sphinx-docs
****************
Run docker image
****************
::
docker run -it --rm \
-v `pwd`/sphinx-docs:/sphinx-docs \
-e SPHINX_DOC_ROOT=/sphinx-docs \
-e SPHINX_BUILDER=singlehtml \
sonodar/sphinx-build
this example, output to `./sphinx-docs/_build`
===================
Docker environments
===================
SPHINX_DOC_ROOT (optional:default=/sphinx)
Sphinx project path in container.
Use docker volumes.
SPHINX_BUILDER (optional:default=html)
Sphinx make command argument.
REQUIREMENTS_FILE (optional)
`pip install -r $REQUIREMENTS_FILE` on pre-build.
Must be included SPHINX_DOC_ROOT.