https://github.com/shimizukawa/docker-sphinxwebapp

Docker Sphinx WebSupport Application
https://github.com/shimizukawa/docker-sphinxwebapp

Last synced: about 15 hours ago
JSON representation

Docker Sphinx WebSupport Application

• Host: GitHub
• URL: https://github.com/shimizukawa/docker-sphinxwebapp
• Owner: shimizukawa
• License: mit
• Created: 2015-02-11T14:11:48.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-02-11T14:27:28.000Z (over 9 years ago)
• Last Synced: 2024-05-01T23:57:13.252Z (5 months ago)
• Language: Python
• Size: 117 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Docker Sphinx WebSupport Application

Docker image with:

- [sphinx](http://sphinx-doc.org/)

- [sphinx-demo-webapp](https://bitbucket.org/shimizukawa/sphinx-demo-webapp)

which execute building a sphinx documentatio you specified, and start Sphinx WebSupport application that provides a comment feature and a search feature.

# Simple usage

`docker run -d -v /path/to/doc:/doc/source -v /path/to/build:/doc/build -v /path/to/db:/var/sphinxweb shimizukawa/sphinxwebapp:latest`

# settings

PATH

- `/app/bin/start`: sphinx webapp bootstrapping bash script

- `/app/config/`: directory contains `sphinxweb.cfg` and `gunicorn.conf.py`

- `/doc/source/`: documentation source directory that contains conf.py for the documentation.

- `/doc/build/`: build output directory that should be permanent.

- `/var/sphinxweb/`: database directory that should be permanent.

ENVIRONMENT

- `SPHINXWEB_SETTINGS`: path to sphinxweb.cfg.

- `SPHINXWEB_PORT`: port number for web server. default is 5000.

- `SPHINXWEB_WORKERS`: number of workers. default is number of cpu core.

Configulation files

- [sphinxweb.cfg](https://github.com/shimizukawa/docker-sphinxwebapp/blob/master/config/sphinxweb.cfg)

- [gunicorn.conf.py](https://github.com/shimizukawa/docker-sphinxwebapp/blob/master/config/gunicorn.conf.py)