From 1686bc576c09c6db2120a6dc09f2e051c4d21b24 Mon Sep 17 00:00:00 2001 From: Masaru Tsuchiyama Date: Tue, 6 Nov 2018 22:49:56 +0900 Subject: [PATCH 1/5] =?UTF-8?q?=E3=83=86=E3=82=B9=E3=83=88=E7=94=A8?= =?UTF-8?q?=E3=81=AE=E3=83=97=E3=83=AD=E3=82=B8=E3=82=A7=E3=82=AF=E3=83=88?= =?UTF-8?q?=E3=82=92=E4=BD=9C=E6=88=90?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Makefile | 19 +++++ make.bat | 35 +++++++++ source/conf.py | 195 +++++++++++++++++++++++++++++++++++++++++++++++ source/index.rst | 20 +++++ 4 files changed, 269 insertions(+) create mode 100644 Makefile create mode 100644 make.bat create mode 100644 source/conf.py create mode 100644 source/index.rst diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..69fe55e --- /dev/null +++ b/Makefile @@ -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/make.bat b/make.bat new file mode 100644 index 0000000..4d9eb83 --- /dev/null +++ b/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +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 diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..7bdef3b --- /dev/null +++ b/source/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/master/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 = u'sandbox' +copyright = u'2018, sakura' +author = u'sakura' + +# The short X.Y version +version = u'' +# The full version, including alpha/beta/rc tags +release = u'' + + +# -- 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.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages', +] + +# 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 = u'jp' + +# 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 = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- 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 = 'alabaster' + +# 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 = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'sandboxdoc' + + +# -- 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, 'sandbox.tex', u'sandbox Documentation', + u'sakura', '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, 'sandbox', u'sandbox 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, 'sandbox', u'sandbox Documentation', + author, 'sandbox', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# 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 intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True \ No newline at end of file diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..1427e66 --- /dev/null +++ b/source/index.rst @@ -0,0 +1,20 @@ +.. sandbox documentation master file, created by + sphinx-quickstart on Tue Nov 6 22:48:59 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to sandbox's documentation! +=================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` From cd75d4fa907dc0caef667c174200585afff79ead Mon Sep 17 00:00:00 2001 From: Masaru Tsuchiyama Date: Tue, 6 Nov 2018 22:58:57 +0900 Subject: [PATCH 2/5] =?UTF-8?q?HTML=20Help=20=E3=82=92=E3=83=93=E3=83=AB?= =?UTF-8?q?=E3=83=89=E3=81=99=E3=82=8B=E3=83=90=E3=83=83=E3=83=81=E3=83=95?= =?UTF-8?q?=E3=82=A1=E3=82=A4=E3=83=AB=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build-sphinx-doc.bat | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 build-sphinx-doc.bat diff --git a/build-sphinx-doc.bat b/build-sphinx-doc.bat new file mode 100644 index 0000000..77efdad --- /dev/null +++ b/build-sphinx-doc.bat @@ -0,0 +1,10 @@ +if exist sandboxdoc.zip del sandboxdoc.zip +if exist build rmdir /s /q build + +pip install sphinx --user +call make.bat htmlhelp + +"C:\Program Files (x86)\HTML Help Workshop\hhc.exe" build\htmlhelp\sandboxdoc.hhp + +copy /Y build\htmlhelp\sandboxdoc.chm . +"C:\Program Files\7-Zip\7z.exe" a sandboxdoc.zip sandboxdoc.chm From e0c3cb024511d52bdea3910be6055d3104363eea Mon Sep 17 00:00:00 2001 From: Masaru Tsuchiyama Date: Tue, 6 Nov 2018 23:02:53 +0900 Subject: [PATCH 3/5] =?UTF-8?q?sphinx=20=E3=81=AE=E3=83=93=E3=83=AB?= =?UTF-8?q?=E3=83=89=E3=83=AB=E3=83=BC=E3=83=AB=E3=82=92=20appveyor=20?= =?UTF-8?q?=E3=81=AB=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- appveyor.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/appveyor.yml b/appveyor.yml index eb21239..92444f8 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -14,3 +14,8 @@ build_script: echo PLATFORM %PLATFORM% echo CONFIGURATION %CONFIGURATION% + + call build-sphinx-doc.bat + +artifacts: +- path: '*.zip' From a8cc042248b1d28a767e81bf31eb20944df27ccc Mon Sep 17 00:00:00 2001 From: Masaru Tsuchiyama Date: Tue, 6 Nov 2018 23:18:46 +0900 Subject: [PATCH 4/5] =?UTF-8?q?PATH=20=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build-sphinx-doc.bat | 2 ++ 1 file changed, 2 insertions(+) diff --git a/build-sphinx-doc.bat b/build-sphinx-doc.bat index 77efdad..210877f 100644 --- a/build-sphinx-doc.bat +++ b/build-sphinx-doc.bat @@ -2,6 +2,8 @@ if exist sandboxdoc.zip del sandboxdoc.zip if exist build rmdir /s /q build pip install sphinx --user + +set PATH=%APPDATA%\Python;%PATH% call make.bat htmlhelp "C:\Program Files (x86)\HTML Help Workshop\hhc.exe" build\htmlhelp\sandboxdoc.hhp From 07f2716490b62d73df3039d2529e0fa543376851 Mon Sep 17 00:00:00 2001 From: Masaru Tsuchiyama Date: Tue, 6 Nov 2018 23:19:52 +0900 Subject: [PATCH 5/5] =?UTF-8?q?=E3=83=91=E3=82=B9=E3=82=92=E4=BF=AE?= =?UTF-8?q?=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build-sphinx-doc.bat | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build-sphinx-doc.bat b/build-sphinx-doc.bat index 210877f..97ed146 100644 --- a/build-sphinx-doc.bat +++ b/build-sphinx-doc.bat @@ -3,7 +3,7 @@ if exist build rmdir /s /q build pip install sphinx --user -set PATH=%APPDATA%\Python;%PATH% +set PATH=%APPDATA%\Python\Scripts;%PATH% call make.bat htmlhelp "C:\Program Files (x86)\HTML Help Workshop\hhc.exe" build\htmlhelp\sandboxdoc.hhp