Add initial documentation

docs/.gitignore

@@ -0,0 +1 @@
+/_build/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = TwirPHP
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/custom.css

@@ -0,0 +1,16 @@
+.row-even .line-block, .row-odd .line-block {
+    margin-left: 0;
+}
+
+.versionmodified {
+    font-weight: bold;
+}
+
+.wy-menu-vertical p.caption {
+    color: #b3b3b3;
+    margin-top: 16px;
+    margin-bottom: 0;
+}
+.wy-menu-vertical p.caption .caption-text {
+    font-size: 120%;
+}

docs/_static/highlight.css

@@ -0,0 +1,59 @@
+div.highlight {
+    background-color: #343131 !important;
+}
+
+div.highlight pre {
+    border: none;
+    color: white !important;
+}
+
+div.highlight pre span.n,
+div.highlight pre span.na,
+div.highlight pre span.nb,
+div.highlight pre span.nc,
+div.highlight pre span.nf,
+div.highlight pre span.nx,
+div.highlight pre span.kn {
+    color: white;
+}
+
+div.highlight pre span.nv {
+    color: #6ab0de
+}
+
+div.highlight pre span.k, div.highlight pre span.o {
+    color: #ff8400;
+}
+
+div.highlight pre span.mi,
+div.highlight pre span.s,
+div.highlight pre span.s1,
+div.highlight pre span.s2,
+div.highlight pre span.sr {
+    color: #56db3a;
+}
+
+div.highlight pre span.hll {
+    background-color: #848484;
+}
+
+div.highlight pre span.hll span.c1 {
+    color: #d8d8d8;
+}
+
+div.highlight pre span.p {
+    color: #b3b3b3;
+}
+
+table.highlighttable td {
+    padding: 0;
+}
+
+table.highlighttable td div.linenodiv {
+    text-align: right;
+    width: 38px;
+}
+
+div.highlight-json pre span.nt {
+    color: cornsilk;
+}

docs/conf.py

@@ -0,0 +1,195 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'TwirPHP'
+copyright = '2018, Márk Sági-Kazár'
+author = 'Márk Sági-Kazár'
+
+# The short X.Y version
+version = '0.1.1'
+# The full version, including alpha/beta/rc tags
+release = 'v0.1.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.todo',
+    'sphinx.ext.ifconfig',
+    'sphinxcontrib.spelling',
+]
+
+# Spelling configuration
+spelling_lang='en_US'
+spelling_word_list_filename='spelling_word_list.txt'
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# 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
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+def setup(app):
+    app.add_stylesheet('custom.css')
+    app.add_stylesheet('highlight.css')
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'TwirPHPdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'TwirPHP.tex', 'TwirPHP Documentation',
+     'Márk Sági-Kazár', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'twirphp', 'TwirPHP Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'TwirPHP', 'TwirPHP Documentation',
+     author, 'TwirPHP', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False

docs/index.rst

@@ -0,0 +1,26 @@
+TwirPHP: PHP port of Twirp, Twitch's RPC framework
+==================================================
+
+`Twirp`_ is a "Twirp is a simple RPC framework built on `protobuf`_."
+Unfortunately (or not?) it only supports Go and Python officially.
+While in the modern world it may be enough for most of the projects,
+there is still a considerable number of PHP-based softwares out there.
+
+This project is a PHP port of Twirp supporting both server and client side.
+It generates code the same way as Twirp does and follows the same conventions.
+Because of that this documentation only contains minimal information about how
+Twirp works internally. To learn more about it, you should check the following
+resources published by the Twirp developers themselves:
+
+* `Official Documentation <https://twitchtv.github.io/twirp/>`_
+* `Introductory Post <https://blog.twitch.tv/twirp-a-sweet-new-rpc-framework-for-go-5f2febbf35f>`_
+
+
+
+.. toctree::
+    :hidden:
+
+    TwirPHP <self>
+
+.. _`Twirp`: https://twitchtv.github.io/twirp/
+.. _`protobuf`: https://developers.google.com/protocol-buffers/

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=TwirPHP
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,5 @@
+sphinx~=1.7.0
+sphinx-rtd-theme==0.1.6
+sphinxcontrib-spelling
+pyenchant
+docutils==0.12

docs/spelling_word_list.txt

@@ -0,0 +1,3 @@
+Twirp
+protobuf
+PHP