OSDN Git Service

Welcome to the Sphinx 1.8.5 quickstart utility.
authorSimon Forman <sforman@hushmail.com>
Tue, 7 May 2019 02:43:36 +0000 (19:43 -0700)
committerSimon Forman <sforman@hushmail.com>
Tue, 7 May 2019 02:43:36 +0000 (19:43 -0700)
docs/VUI-docs/Makefile [new file with mode: 0644]
docs/VUI-docs/make.bat [new file with mode: 0644]
docs/VUI-docs/source/conf.py [new file with mode: 0644]
docs/VUI-docs/source/index.rst [new file with mode: 0644]
setup.py

diff --git a/docs/VUI-docs/Makefile b/docs/VUI-docs/Makefile
new file mode 100644 (file)
index 0000000..69fe55e
--- /dev/null
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+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)
\ No newline at end of file
diff --git a/docs/VUI-docs/make.bat b/docs/VUI-docs/make.bat
new file mode 100644 (file)
index 0000000..543c6b1
--- /dev/null
@@ -0,0 +1,35 @@
+@ECHO OFF\r
+\r
+pushd %~dp0\r
+\r
+REM Command file for Sphinx documentation\r
+\r
+if "%SPHINXBUILD%" == "" (\r
+       set SPHINXBUILD=sphinx-build\r
+)\r
+set SOURCEDIR=source\r
+set BUILDDIR=build\r
+\r
+if "%1" == "" goto help\r
+\r
+%SPHINXBUILD% >NUL 2>NUL\r
+if errorlevel 9009 (\r
+       echo.\r
+       echo.The 'sphinx-build' command was not found. Make sure you have Sphinx\r
+       echo.installed, then set the SPHINXBUILD environment variable to point\r
+       echo.to the full path of the 'sphinx-build' executable. Alternatively you\r
+       echo.may add the Sphinx directory to PATH.\r
+       echo.\r
+       echo.If you don't have Sphinx installed, grab it from\r
+       echo.http://sphinx-doc.org/\r
+       exit /b 1\r
+)\r
+\r
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\r
+goto end\r
+\r
+:help\r
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%\r
+\r
+:end\r
+popd\r
diff --git a/docs/VUI-docs/source/conf.py b/docs/VUI-docs/source/conf.py
new file mode 100644 (file)
index 0000000..c172be4
--- /dev/null
@@ -0,0 +1,179 @@
+# -*- coding: utf-8 -*-\r
+#\r
+# Configuration file for the Sphinx documentation builder.\r
+#\r
+# This file does only contain a selection of the most common options. For a\r
+# full list see the documentation:\r
+# http://www.sphinx-doc.org/en/master/config\r
+\r
+# -- Path setup --------------------------------------------------------------\r
+\r
+# If extensions (or modules to document with autodoc) are in another directory,\r
+# add these directories to sys.path here. If the directory is relative to the\r
+# documentation root, use os.path.abspath to make it absolute, like shown here.\r
+#\r
+# import os\r
+# import sys\r
+# sys.path.insert(0, os.path.abspath('.'))\r
+\r
+\r
+# -- Project information -----------------------------------------------------\r
+\r
+project = u'Joy VUI'\r
+copyright = u'2019, Simon Forman'\r
+author = u'Simon Forman'\r
+\r
+# The short X.Y version\r
+version = u''\r
+# The full version, including alpha/beta/rc tags\r
+release = u'0.1'\r
+\r
+\r
+# -- General configuration ---------------------------------------------------\r
+\r
+# If your documentation needs a minimal Sphinx version, state it here.\r
+#\r
+# needs_sphinx = '1.0'\r
+\r
+# Add any Sphinx extension module names here, as strings. They can be\r
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\r
+# ones.\r
+extensions = [\r
+    'sphinx.ext.autodoc',\r
+    'sphinx.ext.imgmath',\r
+    'sphinx.ext.viewcode',\r
+]\r
+\r
+# Add any paths that contain templates here, relative to this directory.\r
+templates_path = ['_templates']\r
+\r
+# The suffix(es) of source filenames.\r
+# You can specify multiple suffix as a list of string:\r
+#\r
+# source_suffix = ['.rst', '.md']\r
+source_suffix = '.rst'\r
+\r
+# The master toctree document.\r
+master_doc = 'index'\r
+\r
+# The language for content autogenerated by Sphinx. Refer to documentation\r
+# for a list of supported languages.\r
+#\r
+# This is also used if you do content translation via gettext catalogs.\r
+# Usually you set "language" from the command line for these cases.\r
+language = None\r
+\r
+# List of patterns, relative to source directory, that match files and\r
+# directories to ignore when looking for source files.\r
+# This pattern also affects html_static_path and html_extra_path.\r
+exclude_patterns = []\r
+\r
+# The name of the Pygments (syntax highlighting) style to use.\r
+pygments_style = None\r
+\r
+\r
+# -- Options for HTML output -------------------------------------------------\r
+\r
+# The theme to use for HTML and HTML Help pages.  See the documentation for\r
+# a list of builtin themes.\r
+#\r
+html_theme = 'alabaster'\r
+\r
+# Theme options are theme-specific and customize the look and feel of a theme\r
+# further.  For a list of options available for each theme, see the\r
+# documentation.\r
+#\r
+# html_theme_options = {}\r
+\r
+# Add any paths that contain custom static files (such as style sheets) here,\r
+# relative to this directory. They are copied after the builtin static files,\r
+# so a file named "default.css" will overwrite the builtin "default.css".\r
+html_static_path = ['_static']\r
+\r
+# Custom sidebar templates, must be a dictionary that maps document names\r
+# to template names.\r
+#\r
+# The default sidebars (for documents that don't match any pattern) are\r
+# defined by theme itself.  Builtin themes are using these templates by\r
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',\r
+# 'searchbox.html']``.\r
+#\r
+# html_sidebars = {}\r
+\r
+\r
+# -- Options for HTMLHelp output ---------------------------------------------\r
+\r
+# Output file base name for HTML help builder.\r
+htmlhelp_basename = 'JoyVUIdoc'\r
+\r
+\r
+# -- Options for LaTeX output ------------------------------------------------\r
+\r
+latex_elements = {\r
+    # The paper size ('letterpaper' or 'a4paper').\r
+    #\r
+    # 'papersize': 'letterpaper',\r
+\r
+    # The font size ('10pt', '11pt' or '12pt').\r
+    #\r
+    # 'pointsize': '10pt',\r
+\r
+    # Additional stuff for the LaTeX preamble.\r
+    #\r
+    # 'preamble': '',\r
+\r
+    # Latex figure (float) alignment\r
+    #\r
+    # 'figure_align': 'htbp',\r
+}\r
+\r
+# Grouping the document tree into LaTeX files. List of tuples\r
+# (source start file, target name, title,\r
+#  author, documentclass [howto, manual, or own class]).\r
+latex_documents = [\r
+    (master_doc, 'JoyVUI.tex', u'Joy VUI Documentation',\r
+     u'Simon Forman', 'manual'),\r
+]\r
+\r
+\r
+# -- Options for manual page output ------------------------------------------\r
+\r
+# One entry per manual page. List of tuples\r
+# (source start file, name, description, authors, manual section).\r
+man_pages = [\r
+    (master_doc, 'joyvui', u'Joy VUI Documentation',\r
+     [author], 1)\r
+]\r
+\r
+\r
+# -- Options for Texinfo output ----------------------------------------------\r
+\r
+# Grouping the document tree into Texinfo files. List of tuples\r
+# (source start file, target name, title, author,\r
+#  dir menu entry, description, category)\r
+texinfo_documents = [\r
+    (master_doc, 'JoyVUI', u'Joy VUI Documentation',\r
+     author, 'JoyVUI', 'One line description of project.',\r
+     'Miscellaneous'),\r
+]\r
+\r
+\r
+# -- Options for Epub output -------------------------------------------------\r
+\r
+# Bibliographic Dublin Core info.\r
+epub_title = project\r
+\r
+# The unique identifier of the text. This can be a ISBN number\r
+# or the project homepage.\r
+#\r
+# epub_identifier = ''\r
+\r
+# A unique identification for the text.\r
+#\r
+# epub_uid = ''\r
+\r
+# A list of files that should not be packed into the epub file.\r
+epub_exclude_files = ['search.html']\r
+\r
+\r
+# -- Extension configuration -------------------------------------------------\r
diff --git a/docs/VUI-docs/source/index.rst b/docs/VUI-docs/source/index.rst
new file mode 100644 (file)
index 0000000..f8675e1
--- /dev/null
@@ -0,0 +1,20 @@
+.. Joy VUI documentation master file, created by\r
+   sphinx-quickstart on Mon May 06 19:41:42 2019.\r
+   You can adapt this file completely to your liking, but it should at least\r
+   contain the root `toctree` directive.\r
+\r
+Welcome to Joy VUI's documentation!\r
+===================================\r
+\r
+.. toctree::\r
+   :maxdepth: 2\r
+   :caption: Contents:\r
+\r
+\r
+\r
+Indices and tables\r
+==================\r
+\r
+* :ref:`genindex`\r
+* :ref:`modindex`\r
+* :ref:`search`\r
index c0e58fd..9bb5939 100755 (executable)
--- a/setup.py
+++ b/setup.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-#    Copyright © 2014, 2015, 2017 Simon Forman
+#    Copyright © 2014, 2015, 2017, 2019 Simon Forman
 #
 #    This file is part of Thun
 #