No description or website provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
handlers
models
templates/documents
.gitignore
Dockerfile
README.md
main.py
requirements.txt

README.md

documentation-sample

Get code

git clone git@github.com:itkr/documentation-sample.git
cd ./documentation-sample

Run server using local Python and Gunicorn

Install libraries

pip install -r requirements.txt

Run server

gunicorn main:app

http://localhost:8000/docs/

Run server using Docker

Build

docker build -t docs .

Run

docker run --rm -it -p 8000:8000 docs

http://localhost:8000/docs/

Required libraries

name reason
docutils reStructuredTextを扱う
gunicorn WSGI HTTP Server
jinja2 テンプレートエンジン
jsonschema JSONSchemaを扱う
paste ローカルでwebサーバーを動かす
pygments reStructuredTextでコードブロックを扱うときに使用
webapp2 Webフレームワーク
webob webapp2で使用