Skip to content

jubatus/website

Repository files navigation

Jubatus Website

About

This repository holds Sphinx source files for http://jubat.us/ website.

Contributions are always welcomed, from tiny typos to enhancements. Feel free to make pull-requests to this repository.

Requirements

  • Python 2.7 + Sphinx 1.4.3 + blockdiag + sphinx_rtd_theme

Easy setup for Ubuntu 16.04 systems:

# apt-get install python-sphinx latex-cjk-japanese texlive-latex-extra dvipng
# pip install sphinxcontrib-blockdiag sphinxcontrib-rubydomain sphinx_rtd_theme

How to Edit

First of all, clone this repository (if you don't have a commit access, use your fork).

$ git clone git@github.com:jubatus/website.git

Edit the document.

$ edit source/index.rst

Build and preview the changes you made.

$ omake html
$ open build/html/index.html

Looks good? Now, push it.

$ git push origin master

Then open a pull-request.

For Jubatus members: you can deploy it to http://jubat.us/ website.

$ ./publish.sh

How to Build using Docker

$ docker build -t website-builder .
$ docker run --rm -v $PWD:/data website-builder

Copyright

(C) PFN & NTT