Merge pull request #52 from kobinpy/update-docs

Update docs
kobinpy · Dec 1, 2016 · 1a7adb3 · 1a7adb3
2 parents 3edbea7 + 57e2d9a
commit 1a7adb3
Show file tree

Hide file tree

Showing 26 changed files with 132 additions and 36 deletions.
diff --git a/.gitignore b/.gitignore
@@ -38,7 +38,7 @@ coverage.xml
 *,cover
 
 # Sphinx documentation
-doc/build/
+docs/build/
 *.mo
 # transifex
 .tx

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -5,6 +5,7 @@ CHANGES
 ------------------
 
 * Integrating wsgicli.
+* Alter sphinx theme.
 * Update documentations.
 
 0.0.5 (2016-11-28)

diff --git a/doc/source/_static/favicon.ico b/doc/source/_static/favicon.ico
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/docs/source/_static/favicon.ico b/docs/source/_static/favicon.ico
diff --git a/docs/source/_static/kobin.png b/docs/source/_static/kobin.png
diff --git a/doc/source/_static/logo.png → docs/source/_static/logo.png b/doc/source/_static/logo.png → docs/source/_static/logo.png
diff --git a/docs/source/_static/ogp.png b/docs/source/_static/ogp.png
diff --git a/docs/source/_static/ogp_ja.png b/docs/source/_static/ogp_ja.png
diff --git a/docs/source/_static/twitter_share.png b/docs/source/_static/twitter_share.png
diff --git a/docs/source/_static/twitter_share_ja.png b/docs/source/_static/twitter_share_ja.png
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
@@ -0,0 +1,65 @@
+{% extends "basic/layout.html" %}
+
+{%- block doctype -%}
+<!DOCTYPE html>
+{%- endblock -%}
+
+{%- block extrahead -%}
+<!-- meta title -->
+<meta content="{{ title }}" name="title" />
+<meta property="og:title" content="{{ title }}" />
+<meta name="twitter:title" content="{{ title }}" />
+
+<!-- Switch by language -->
+{% if language == 'ja' %}
+<meta name="description" content="Kobin(小瓶): Type Hintsを活用した軽量WSGIフレームワーク" />
+<meta property="og:description" content="Kobin(小瓶): Type Hintsを活用した軽量WSGIフレームワーク" />
+<meta name="twitter:description" content="Kobin(小瓶): Type Hintsを活用した軽量WSGIフレームワーク" />
+
+<meta property="og:url" content="http://kobin.readthedocs.io/ja/latest/" />
+<meta property="og:image" content="http://kobin.readthedocs.io/ja/latest/_images/ogp_ja.png" />
+<meta name="twitter:image" content="http://kobin.readthedocs.io/ja/latest/_images/twitter_share_ja.png" />
+{% else %} <!-- use en -->
+<meta name="description" content="Kobin is a small and statically-typed WSGI micro web framework for Python3." />
+<meta property="og:description" content="Kobin is a small and statically-typed WSGI micro web framework for Python3." />
+<meta name="twitter:description" content="Kobin is a small and statically-typed WSGI micro web framework for Python3." />
+
+<meta property="og:url" content="http://kobin.readthedocs.io/en/latest/" />
+<meta property="og:image" content="http://kobin.readthedocs.io/en/latest/_images/ogp.png" />
+<meta name="twitter:image" content="http://kobin.readthedocs.io/en/latest/_images/twitter_share.png" />
+{% endif %}
+
+<meta property="og:image:width" content="1200" />
+<meta property="og:image:height" content="630" />
+
+<meta property="og:type" content="website" />
+<meta property="og:type" content="website"/>
+
+<meta name="twitter:card"  content="summary_large_image" />
+<meta name="twitter:site" content="@c_bata_" />
+
+<link href='http://fonts.googleapis.com/css?family=Source+Code+Pro|Open+Sans:300italic,400italic,700italic,400,300,700' rel='stylesheet' type='text/css'>
+<link href="{{ pathto("_static/solarized-dark.css", 1) }}" rel="stylesheet">
+<link href="{{ pathto("_static/favicon.ico", 1) }}" rel="icon" }}">
+<style>
+    body {
+        max-width: 1100px;
+        margin: 0 auto;
+    }
+</style>
+{%- endblock -%}
+
+{# put the sidebar before the body #}
+{% block sidebar1 %}
+<a href="https://github.com/kobinpy/kobin"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/652c5b9acfaddf3a9c326fa6bde407b87f7be0f4/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6f72616e67655f6666373630302e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"></a>
+{{ sidebar() }}
+{% endblock %}
+{% block sidebar2 %}{% endblock %}
+
+{%- block footer %}
+    <div class="footer">
+        <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br />WebFramework in Python by Masashi Shibata is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
+        <br />
+        {%- if show_sphinx %}{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.Theme by <a href="http://github.com/vkvn">vkvn</a>{% endtrans %}{%- endif %}
+    </div>
+{%- endblock %}
diff --git a/doc/source/api.rst → docs/source/api.rst b/doc/source/api.rst → docs/source/api.rst
diff --git a/doc/source/conf.py → docs/source/conf.py b/doc/source/conf.py → docs/source/conf.py
@@ -3,6 +3,7 @@
 
 import sys
 import os
+import solar_theme
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -77,8 +78,8 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'bizstyle'
-html_theme_options = {'maincolor' : "#3D90AB"}
+html_theme = 'solar_theme'
+html_theme_path = [solar_theme.theme_path]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -97,7 +98,7 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = '_static/kobin.png'
 
 html_favicon = 'favicon.ico'
 

diff --git a/doc/source/devguide.rst → docs/source/devguide.rst b/doc/source/devguide.rst → docs/source/devguide.rst
diff --git a/doc/source/index.rst → docs/source/index.rst b/doc/source/index.rst → docs/source/index.rst
@@ -1,11 +1,8 @@
 .. title:: Welcome to Kobin
 
-==================
-|Welcome to Kobin|
-==================
-
-.. |Welcome to Kobin| image:: ./_static/logo.png
-   :alt: Welcome to Kobin
+================
+Welcome to Kobin
+================
 
 Kobin is a small and statically-typed WSGI micro web framework for Python.
 **This library is a pre-release. Expect missing docs and breaking API changes.**

diff --git a/doc/source/locale/ja/LC_MESSAGES/api.po → docs/source/locale/ja/LC_MESSAGES/api.po b/doc/source/locale/ja/LC_MESSAGES/api.po → docs/source/locale/ja/LC_MESSAGES/api.po
diff --git a/doc/source/locale/ja/LC_MESSAGES/devguide.po → .../source/locale/ja/LC_MESSAGES/devguide.po b/doc/source/locale/ja/LC_MESSAGES/devguide.po → .../source/locale/ja/LC_MESSAGES/devguide.po
diff --git a/doc/source/locale/ja/LC_MESSAGES/index.po → docs/source/locale/ja/LC_MESSAGES/index.po b/doc/source/locale/ja/LC_MESSAGES/index.po → docs/source/locale/ja/LC_MESSAGES/index.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: kobin 0.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2016-12-01 15:14+0900\n"
+"POT-Creation-Date: 2016-12-01 17:03+0900\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -18,101 +18,104 @@ msgstr ""
 "Generated-By: Babel 2.3.4\n"
 
 #: ../../source/index.rst:5
-msgid "|Welcome to Kobin|"
-msgstr ""
+msgid "Welcome to Kobin"
+msgstr "Kobin"
 
-#: ../../source/index.rst:10
+#: ../../source/index.rst:7
 msgid ""
 "Kobin is a small and statically-typed WSGI micro web framework for "
 "Python. **This library is a pre-release. Expect missing docs and breaking"
 " API changes.** Kobin has following features."
 msgstr "Kobin(小瓶)はPython製Webフレームワークです。開発中のためドキュメンテーションの不備やAPIの大きな変更があるかもしれません。ご注意ください。Kobinの特徴は以下のとおりです。"
 
-#: ../../source/index.rst:14
+#: ../../source/index.rst:11
 msgid "**Statically-typed** web framework with PEP 0484(Type Hints)."
 msgstr "PEP 0484(Type Hints)を活かした実装となっています。"
 
-#: ../../source/index.rst:15
+#: ../../source/index.rst:12
 msgid "**Lightweight** implementations for solving your problems easily."
 msgstr "フレームワーク自体がシンプルに実装されているため、問題が合ったときに内部まで目を通して解決することが出来ます。"
 
-#: ../../source/index.rst:16
+#: ../../source/index.rst:13
 msgid ""
 "Kobin provides Routing, WSGI request and response wrapper, Jinja2 "
 "template adapter and several useful utilities"
 msgstr "Kobinは主にルーティング、WSGIリクエスト・レスポンスオブジェクト、Jinja2のアダプターを提供しています。"
 
-#: ../../source/index.rst:20
+#: ../../source/index.rst:17
 msgid "Installation"
 msgstr "インストール"
 
-#: ../../source/index.rst:28
+#: ../../source/index.rst:25
 msgid "Hello World"
 msgstr ""
 
-#: ../../source/index.rst:44
+#: ../../source/index.rst:41
 msgid "Requirements"
 msgstr ""
 
-#: ../../source/index.rst:46
+#: ../../source/index.rst:43
 msgid "Kobin Requires the following:"
 msgstr "Kobinを動かすには以下のものが必要です。"
 
-#: ../../source/index.rst:48
+#: ../../source/index.rst:45
 msgid "Python 3.5"
 msgstr ""
 
-#: ../../source/index.rst:50
+#: ../../source/index.rst:47
 msgid ""
 "Kobin is no dependencies other than the `Python Standard Library "
 "<https://docs.python.org/3/library/>`_. The following packages are "
 "optional:"
 msgstr "以下のライブラリはオプショナルです。必要に応じてインストールしてください。"
 
-#: ../../source/index.rst:53
+#: ../../source/index.rst:50
 msgid "Jinja2"
 msgstr ""
 
-#: ../../source/index.rst:54
+#: ../../source/index.rst:51
 msgid "gunicorn"
 msgstr ""
 
-#: ../../source/index.rst:58
+#: ../../source/index.rst:55
 msgid "Kobin documentation contents"
 msgstr "目次"
 
-#: ../../source/index.rst:69
+#: ../../source/index.rst:66
 msgid "Links"
 msgstr "リンク"
 
-#: ../../source/index.rst:71
+#: ../../source/index.rst:68
 msgid "`Github <https://github.com/kobinpy/kobin>`_"
 msgstr ""
 
-#: ../../source/index.rst:72
+#: ../../source/index.rst:69
 msgid "`PyPI <https://pypi.python.org/pypi/kobin>`_"
 msgstr ""
 
-#: ../../source/index.rst:76
+#: ../../source/index.rst:73
 msgid "Indices and tables"
 msgstr "索引表"
 
-#: ../../source/index.rst:78
+#: ../../source/index.rst:75
 msgid ":ref:`genindex`"
 msgstr ""
 
-#: ../../source/index.rst:79
+#: ../../source/index.rst:76
 msgid ":ref:`modindex`"
 msgstr ""
 
-#: ../../source/index.rst:80
+#: ../../source/index.rst:77
 msgid ":ref:`search`"
 msgstr ""
 
-#: ../../source/index.rst:84
+#: ../../source/index.rst:81
 msgid "Statuses"
 msgstr "ステータス"
 
 #~ msgid "`Github <https://github.com/c-bata/kobin>`_"
 #~ msgstr ""
 
+#~ msgid "|Welcome to Kobin|"
+#~ msgstr ""
+
diff --git a/doc/source/locale/ja/LC_MESSAGES/modules.po → docs/source/locale/ja/LC_MESSAGES/modules.po b/doc/source/locale/ja/LC_MESSAGES/modules.po → docs/source/locale/ja/LC_MESSAGES/modules.po
diff --git a/docs/source/locale/ja/LC_MESSAGES/sphinx.po b/docs/source/locale/ja/LC_MESSAGES/sphinx.po
@@ -0,0 +1,26 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2016, Masashi Shibata
+# This file is distributed under the same license as the kobin package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2016.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: kobin 0.0.4\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2016-12-01 17:03+0900\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.3.4\n"
+
+#: ../../source/_templates/layout.html:46
+#, python-format
+msgid ""
+"Created using <a href=\"http://sphinx.pocoo.org/\">Sphinx</a> "
+"%(sphinx_version)s.Theme by <a href=\"http://github.com/vkvn\">vkvn</a>"
+msgstr ""
+
diff --git a/doc/source/locale/ja/LC_MESSAGES/tutorial.po → .../source/locale/ja/LC_MESSAGES/tutorial.po b/doc/source/locale/ja/LC_MESSAGES/tutorial.po → .../source/locale/ja/LC_MESSAGES/tutorial.po
diff --git a/doc/source/tutorial.rst → docs/source/tutorial.rst b/doc/source/tutorial.rst → docs/source/tutorial.rst
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -5,4 +5,4 @@ ipdb
 
 sphinx
 sphinx-intl
-sphinx-rtd-theme
+solar-theme
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -0,0 +1,3 @@
+# Requirements file for read the docs
+sphinx
+solar-theme
diff --git a/setup.cfg b/setup.cfg
@@ -3,7 +3,7 @@ release = register sdist bdist_wheel upload
 
 [flake8]
 max-line-length = 120
-exclude = venv/*.py,build/*.py,*/__init__.py,doc/*.py
+exclude = venv/*.py,build/*.py,*/__init__.py,docs/*.py
 ignore = F401
 
 [pytest]